Skip to content

Documentation update#41

Merged
stuitje merged 24 commits intomainfrom
ks/docs_update
Feb 22, 2026
Merged

Documentation update#41
stuitje merged 24 commits intomainfrom
ks/docs_update

Conversation

@stuitje
Copy link
Contributor

@stuitje stuitje commented Feb 22, 2026

Description

A documentation update for MORS to align more with the style and features of the other PROTEUS submodule documentations. Partially addresses FormingWorlds/PROTEUS#635. Now includes:

  • An updated landing page with a 'getting started'
  • Light/dark mode
  • PROTEUS logo links to proteus-framework.org; MORS links to homepage MORS docs (used javascripts)
  • updated badges
  • updated navigation structure and submodule links
  • added contacts page
  • updates to How-to's
  • updates to all note / info blocks
  • info about installation within PROTEUS framework added
  • new publications + bibliography page (publications.md) and links to this throughout the code. A later option is also including footnote citations with bibtex. Also includes a link to all PROTEUS publications.

Verification

The documentation was built locally using mkdocs serve.

People

@nichollsh @timlichtenberg

@stuitje stuitje self-assigned this Feb 22, 2026
@stuitje stuitje requested a review from a team as a code owner February 22, 2026 15:18
@stuitje stuitje added the documentation Improvements or additions to documentation label Feb 22, 2026
@stuitje stuitje changed the title DRAFT Documentation update Documentation update Feb 22, 2026
@nichollsh
Copy link
Member

@stuitje I think you should set use_directory_urls: false in the mkdocs.yml file, for consistency with the other repos.

Copy link
Member

@nichollsh nichollsh left a comment

Choose a reason for hiding this comment

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

Overall looks good so far, but found a broken link. See also comment above about setting use_directory_urls: false.

stuitje and others added 2 commits February 22, 2026 18:40
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
@stuitje
Copy link
Contributor Author

stuitje commented Feb 22, 2026

@nichollsh thanks a lot for the comments! everything should now be implemented

@nichollsh nichollsh self-requested a review February 22, 2026 18:38
Copy link
Member

@nichollsh nichollsh left a comment

Choose a reason for hiding this comment

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

Looks good now. Thanks for implementing my suggestions, @stuitje

@stuitje stuitje merged commit 30fc462 into main Feb 22, 2026
6 checks passed
@stuitje stuitje deleted the ks/docs_update branch February 22, 2026 20:27
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants