Skip to content

Simplify user-facing method documentation - #87

Merged
dcajal merged 1 commit into
mainfrom
docs/simplify-user-documentation
Aug 12, 2026
Merged

Simplify user-facing method documentation#87
dcajal merged 1 commit into
mainfrom
docs/simplify-user-documentation

Conversation

@dcajal

@dcajal dcajal commented Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace separate specification and scientific-note pages with one practical page per method
  • generate interface tables, references, and technical links during the MkDocs build
  • reduce the public navigation to Home, Methods, Implementations, and Cite
  • remove public conformance-case tables and historical implementation commentary
  • simplify repository guidance and contribution documentation

Impact

Users now have one place to understand a method, its inputs and outputs, scientific context, limitations, references, and implementation links. Normative JSON specifications and shared cases remain available as technical resources without being duplicated in the public site.

Translation support is intentionally outside this change.

Validation

  • .venv\Scripts\python.exe -m compileall tools
  • .venv\Scripts\python.exe -m unittest discover -s tests -v (16 passed)
  • .venv\Scripts\python.exe tools\validate_specs.py
  • .venv\Scripts\python.exe -m mkdocs build --strict
  • git diff --check

@dcajal
dcajal merged commit 4b8ce55 into main Aug 12, 2026
4 checks passed
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