Repository navigation
Organise the documentation site for its readers (Diátaxis, three paths) - #155
Merged
Merged
Conversation
Owner-approved restructure (option A for 0.6.0): Get started; Grower, Agronomist and Developer and researcher guides, each with an overview and a diagram; Reference (command line generated from --help by tools/cli_reference.py, Python API, input files, error codes, reading plans, the offline manual); Explanation (how a recipe is calculated, water and pH, scope and limits, the models); Evidence; Project (changelog, release notes, citation, license and credits, security, code of conduct, roadmap). The growers page is split by reader; other guide pages move whole with git mv. Every moved page redirects from its old address (sphinx-reredirects), and Mermaid draws six diagrams (sphinxcontrib-mermaid); both are pinned docs-only tools. Links to moved pages are rewritten across the site and the repository. tests/test_docs_structure.py checks that every page is in a menu once, every redirect resolves, and the command-line reference is current.
Documentation build overview
56 files changed ·
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #155 +/- ##
=======================================
Coverage 89.82% 89.82%
=======================================
Files 54 54
Lines 7371 7371
=======================================
Hits 6621 6621
Misses 750 750
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
rafatahmed
marked this pull request as ready for review
October 23, 2026 21:50
rafatahmed
added a commit
that referenced
this pull request
Nov 7, 2026
Organise the documentation site for its readers (Diátaxis, three paths)
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.
The documentation site, organised for its three readers: the grower, the agronomist, and the developer or researcher. It follows the Diátaxis structure: tutorials, how-to guides, reference and explanation. This is option A as approved by the owner on 2026-10-23: it ships with 0.6.0, and the tutorials with screenshots, the glossary and the trimmed offline manual follow in 0.6.1.
New menu
--help) · Python API · Input files · Error codes · Reading plans and results · User manual (offline)The home page explains what FlahaX does, with the diagram "From your water to your tanks", then offers three doors (Grower, Agronomist, Developer and researcher), the install line, and the status and limits.
How it was done
growers.mdis split by reader, along its own sections.git mv, so their history is kept.growers.html, which the README and the published 0.5.0 page link to.INTEGRATION.md,examples/README.md,docs/*).sphinxcontrib-mermaid==2.1.1for the diagrams andsphinx-reredirects==1.1.0for the redirects. The package keeps zero runtime dependencies.SECURITY.md,CODE_OF_CONDUCT.md,CONTRIBUTING.md,NOTICEandCITATION.cffdirectly, and the error-code page includes the manual's tables. Nothing is copied by hand.Tests
tests/test_docs_structure.py, new, checks that:reference/cli.mdmatches the current--help(tools/cli_reference.py --check).tests/test_growers_page.pynow reads the worked example fromagronomist/batch-command.md.Review
Read the Docs builds a preview of this PR; the link appears in the checks below. Please review the menu and the pages there.