📝 docs: restructure following Diataxis framework#448
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Feb 16, 2026
Merged
📝 docs: restructure following Diataxis framework#448gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
The documentation mixed tutorials, explanations, how-to recipes, and reference material in the same files making it hard for users to find what they need depending on context. Reorganize into proper Diataxis quadrants: - tutorial.rst: step-by-step learning guide for new users - explanation.rst: platform conventions and design rationale - howto.rst: task-oriented recipes without explanatory prose - api.rst: iterator methods section and AppDirs alias - platforms.rst: pure reference tables (moved prose to explanation) Also add Sphinx extensions (sphinx-copybutton, sphinx-design, sphinx-sitemap, sphinxcontrib-mermaid, sphinxext-opengraph), docstrfmt pre-commit hook, and align ruff config with docstrfmt formatting.
9dbfde0 to
7b7a417
Compare
Collaborator
|
Nice! |
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 mixed learning material, task recipes, background explanations, and API reference within the same files. A newcomer landing in
usage.rsthad to wade through platform conventions and production examples just to find how to calluser_data_dir. Someone looking for a quick recipe had to skim past explanatory prose to reach the code. 📚 This made it harder than necessary to find the right information for the task at hand.This restructures everything into the four quadrants of the Diataxis framework. A proper
tutorial.rstwalks new users through installation to a working example with verifiable output at each step.howto.rstis stripped to action-first recipes including new ones for config merging viaiter_config_paths, mocking in tests, and environment variable overrides. All platform convention prose — macOS~/Librarybehavior, WindowsWIN_PD_OVERRIDE_*variables, XDG details, Android detection — is consolidated intoexplanation.rstinstead of being scattered across three files. The reference pages (api.rst,platforms.rst) stay austere, withapi.rstnow surfacing theiter_*methods and theAppDirsbackwards-compatibility alias.This also adds
docstrfmtas a pre-commit hook for consistent RST and docstring formatting, along with Sphinx extensions (sphinx-copybutton,sphinx-design,sphinxcontrib-mermaid,sphinxext-opengraph,sphinx-sitemap) that improve the rendered docs. The ruff config is adjusted to defer todocstrfmtfor docstring style, and the release workflow script is fixed to producedocstrfmt-compatible changelog entries — it was missing a blank line after section underlines and generating overlines one character too short.