Open
Conversation
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.
This Pull Request addresses Issue #15 regarding documentation improvements. It transforms the documentation from a single, static README into a professional, multi-page MkDocs site with a clear Information Architecture.
Key Changes
Structural Reorganization: Decomposed the
README.mdinto a structureddocs/directory featuring dedicated sections for Explanation, Guides, and Reference.Enhanced Navigation: Updated
mkdocs.ymlwith a logical navigation hierarchy to improve discoverability of core features.Expanded Getting Started Guide: Revised the tutorial to include environment verification and a practical example of compiling a vectorized SIR model.
Technical Deep Dives: Added comprehensive documentation for RHS Specifications (
kind: exprandkind: transitions), spatial Axes, and Mixing Kernels.API Documentation: Integrated a structured reference for primary functions like
compile_specandnormalize_rhs.Verification
The site was verified locally using
mkdocs serve.All navigation links and code snippets were checked for accuracy against the source logic in
src/op_system.Closes: ISSUE #15