Skip to content

Documentation update#4

Merged
stuitje merged 10 commits intomainfrom
ks/fix_links
Feb 19, 2026
Merged

Documentation update#4
stuitje merged 10 commits intomainfrom
ks/fix_links

Conversation

@stuitje
Copy link

@stuitje stuitje commented Feb 19, 2026

This PR mainly fixes the broken links to other modules (after the casing discussion we had) and adds a few new features to the SPIDER documentation. This partially addresses the issue FormingWorlds/PROTEUS#635.

  • Note blocks are updated to match the style in Aragog and PROTEUS
  • New link in navigation, 'Community', now includes 'Contact' (copied and slightly adjusted from PROTEUS), 'Code of Conduct' (moved) and 'Developers' (links to proteus-framework.org/people). Other modules are now linked under 'Other PROTEUS modules' and contains the aforementiones fixed links.
  • Publications now includes a link to the PROTEUS publications, as in Aragog
  • Installation now links to the 'normal' installation as part of a PROTEUS installation in a note
  • PROTEUS logo now links to proteus-framework.org, i.e. the general homepage, via a javascript extra.
  • SPIDER title links to the documentation homepage of spider, i.e. proteus-framework.org/SPIDER.

Validation

I built the documentation locally using mkdocs serve and checked all links.

@stuitje stuitje self-assigned this Feb 19, 2026
Copilot AI review requested due to automatic review settings February 19, 2026 13:06
@stuitje stuitje added the documentation Improvements or additions to documentation label Feb 19, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

@nichollsh
Copy link
Member

Looks good to me. These info boxes look really cool.

@stuitje stuitje merged commit 5dca76d into main Feb 19, 2026
7 checks passed
@stuitje stuitje deleted the ks/fix_links branch February 19, 2026 15:26
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.

3 participants