Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces an initial MkDocs-based documentation website for the SOCRATES codebase, including site navigation, theming/custom assets, and a GitHub Pages deployment workflow.
Changes:
- Add MkDocs configuration (
mkdocs.yml) with initial docs IA (Home / How-to / Explanations / Reference / Community). - Add custom Material theme styling + overrides (CSS, JS, template override) and documentation content pages.
- Add a GitHub Actions workflow to build and deploy the docs to GitHub Pages, plus ignore the generated
site/output.
Reviewed changes
Copilot reviewed 20 out of 31 changed files in this pull request and generated 6 comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Defines MkDocs/Material configuration and site navigation for the new docs site |
docs/index.md |
Adds a landing page describing SOCRATES and its PROTEUS/AGNI context |
docs/How-to/installation.md |
Adds a placeholder installation page linking to external install docs |
docs/Explanations/*.md |
Adds initial explanatory documentation pages (two-stream, spherical harmonic, spectral files, interface, integration, overview) |
docs/Reference/*.md |
Adds reference pages for standard Met Office and PROTEUS spectral files |
docs/Community/*.md |
Adds community pages (contact + code of conduct) |
docs/stylesheets/*.css |
Adds theme CSS for PROTEUS-style branding and footnote/subtitle tweaks |
docs/overrides/main.html |
Adds a template override to manage theme-dependent favicons |
docs/javascripts/header-links.js |
Adds header click behavior for logo/title navigation |
docs/assets/*.png |
Adds logo and schematic image assets used by the site |
.github/workflows/docs.yaml |
Adds GitHub Pages deployment workflow for the documentation |
.gitignore |
Ignores generated MkDocs site output directory (site/) |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
nichollsh
requested changes
Apr 12, 2026
Member
nichollsh
left a comment
There was a problem hiding this comment.
Very nice - great to have some documentation for SOCRATES! Some suggestions/corrections below.
Next, it would be great if the LaTeX-built techguide and userguide PDFs could be embedded or referenced in the website, by drawing these straight from GitHub actions (see comment below).
Co-authored-by: Harrison Nicholls <32022679+nichollsh@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
PR Summary
This PR implements the first version of documentation for SOCRATES, using Zensical and an mkdocs configuration style, in the same style as proteus. It is not complete yet and will be updated soon. Main added pages:
It misses most notably a full installation guide and tutorial, publications, and a getting started page which will be added soon (after I am back from holiday)
Code Quality Checklist
readability of the code
AI Assistance and Attribution
of Claude Sonnet 4.6, and I have followed the AI guidelines in the PROTEUS documentation.
Documentation
confirmed that it builds correctly
Sci/Tech Review
Please alert the code reviewer via a tag when you have approved the SR
Code Review