8000 docs: organize public guides and preserve validation history by rafatahmed · Pull Request #34 · rafatahmed/Flahax · GitHub
[go: up one dir, main page]

Skip to content

docs: organize public guides and preserve validation history - #34

Merged
rafatahmed merged 2 commits into
mainfrom
docs/readthedocs-site
Oct 20, 2026
Merged

rafatahmed merged 2 commits into
mainfrom
docs/readthedocs-site

Conversation

@rafatahmed
Copy link
Copy Markdown
Owner

The public planning guides mixed usage instructions with internal milestones and dated development logs. Organize navigation into Get started, Growers and agronomists, User manual, API reference, Models and chemistry, Evidence and audits, and Changelog.

Detailed workflows now sit under the manual, schemas and units under the API reference, and source reviews and verification records under Evidence and audits. Remove milestone labels from navigation, clarify the measured-curve versus equilibrium pH workflows, and distinguish the three EC methods.

Preserve existing page URLs and affected section anchors. Relocate historical validation logs and superseded pH requirements without changing their original text; retain provenance, model limits, failed-run context, and distinctions between computational evidence and physical validation. Document the maintenance rules for this organization.

Validation:

  • Sphinx HTML build with warnings treated as errors passed.
  • All 9 documentation tests passed.
  • Generated navigation has exactly the seven requested sections.
  • Generated internal HTML page links and preserved section anchors verified.
  • Relocated historical records compared against their original Git contents and confirmed unchanged.
  • git diff --check passed.

Documentation only; no chemistry, runtime behavior, or scientific parameters changed.

@read-the-docs-community
read-the-docs-community Bot commented Oct 20, 2026 •
Copy link
Copy Markdown

@rafatahmed
rafatahmed merged commit 4c0ea9c into main Oct 20, 2026
6 checks passed
@rafatahmed
rafatahmed deleted the docs/readthedocs-site branch October 20, 2026 08:12
@rafatahmed rafatahmed self-assigned this Oct 20, 2026
rafatahmed added a commit that referenced this pull request Nov 7, 2026
docs: organize public guides and preserve validation history
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant

0