📝 docs(readme): restructure with Diataxis sections#292
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Mar 2, 2026
Merged
📝 docs(readme): restructure with Diataxis sections#292gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
gaborbernat
added
bug
The flat README mixed installation, configuration reference, and usage examples without clear separation, making it hard for users to find what they need depending on their goal. Reorganized into Diataxis-aligned sections: Getting started (tutorial), How-to guides (task recipes), Reference (option tables), and Live examples. All existing content is preserved, just restructured so users can navigate by intent.
gaborbernat
force-pushed
the
fix-empty-title-toctree
branch
from
e063c76 to
50f0fb9
Compare
gaborbernat
changed the title
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
1 participant
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 README mixed installation, configuration reference, and usage examples in a flat structure, making it hard for users to find what they need depending on whether they're getting started, solving a specific task, or looking up an option.
Reorganized into Diataxis-aligned sections: Getting started (install → configure → minimal directive), How-to guides (9 task-oriented recipes for common operations like
:prog:,:hook:, cross-referencing, etc.), Reference (directive options andconf.pyvalues as structured tables), and Live examples. All existing content is preserved — just restructured so users can navigate by intent rather than reading linearly.