Docs: Add templating documentation to mkdocs navigation#23
Merged
tomdurrant merged 36 commits intomainfrom Feb 17, 2026
Merged
Conversation
…and worked examples
- Fix backends.md opening sentence to include non-wave models (ocean and coastal) - Add license reference to contributing.md - Standardize bullet point punctuation with periods for complete sentences - Standardize post-processing hyphenation throughout documentation Addresses feedback on term consistency, formatting, and documentation completeness.
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.
Summary
Complete documentation restructuring and enhancement for rompy. This PR introduces a new docs architecture with improved navigation, comprehensive guides, and new content.
Major Changes
New Documentation Structure:
New Content:
getting_started.md- Quick onboarding guideprogressive_tutorials.md- Step-by-step learning pathexamples.md- Practical usage examplescommon_workflows.md- Frequently used patternsextending_models.md- Guide for adding new modelsfaq.md- Frequently asked questionsconfiguration_deep_dive.md- Advanced configuration patternstemplating.md- Template variable substitution documentationtesting_guide.md- Comprehensive testing documentationswan_guide.md,schism_guide.md,xbeach_guide.md,ww3_guide.mdUpdated Content:
index.md- Refreshed introduction and overviewcore_concepts.md- Enhanced explanationscontributing.md- Expanded contribution guidelinesapi.md- Updated API referenceplugin_architecture.md- Improved plugin documentationbackends.md- Enhanced backend documentationRemoved:
quickstart.md- Replaced by getting_started.mdinstallation.md- Merged into getting_started.mdInfrastructure:
Files Changed
Testing
Ready for review!