Skip to content

Add SIST logo and refresh README ahead of release - #45

Merged
harryswift01 merged 2 commits into
mainfrom
44-general-add-sist-logo
Sep 8, 2026
Merged

Add SIST logo and refresh README ahead of release#45
harryswift01 merged 2 commits into
mainfrom
44-general-add-sist-logo

Conversation

@harryswift01

Copy link
Copy Markdown
Member

Summary

This PR will add the SIST logo to the docs and README and give the README a general pre-release refresh (status badges, citation formatting, contact info) ahead of publishing to Anaconda.

Changes

Add SIST logo:

  • Add dark/light SIST logo SVGs under docs/source/_static/logos/
  • Wire logos into the Sphinx furo theme via html_theme_options in conf.py
  • Embed the logo in the README (dark/light variants via GitHub's #gh-dark-mode-only / #gh-light-mode-only)

Add status badges:

  • Add a badges table to the README (Build, Documentation, Anaconda, Quality)

Restructure citations:

  • Split the required software citation from the transition-specific papers
  • Map each optional paper to its transition type (strand separation, BZ transition, cruciform extrusion) in a table
  • Link to CITATION.cff for citing the software itself

Update contact info:

  • Replace individual author emails with CCPBIOSIM@stfc.ac.uk

Impact

  • No functional/code changes, README and Sphinx docs config only
  • Anaconda badges are placeholders that will resolve once the sist package is published to the CCPBioSim channel

@harryswift01 harryswift01 self-assigned this Sep 7, 2026
@harryswift01 harryswift01 added documentation Improvements or additions to documentation enhancement New feature or request labels Sep 7, 2026
@harryswift01 harryswift01 linked an issue Sep 7, 2026 that may be closed by this pull request
@harryswift01
harryswift01 requested a review from jimboid September 8, 2026 08:08

@jimboid jimboid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great. We know that the formula works well from other repositories with this structure.

@harryswift01
harryswift01 merged commit 756706d into main Sep 8, 2026
2 checks passed
@harryswift01
harryswift01 deleted the 44-general-add-sist-logo branch September 8, 2026 08:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[General]: Add SIST Logo and Branding to Documentation

2 participants