📝 docs: restructure documentation using Diátaxis framework#3718
Merged
gaborbernat merged 1 commit intotox-dev:mainfrom Feb 17, 2026
Merged
📝 docs: restructure documentation using Diátaxis framework#3718gaborbernat merged 1 commit intotox-dev:mainfrom
gaborbernat merged 1 commit intotox-dev:mainfrom
Conversation
487c804 to
a3086f4
Compare
Documentation was organized in a single flat structure that mixed tutorials, how-to guides, reference material, and explanations together. This made it difficult for users to find the right information for their skill level and use case. Adopted the Diátaxis framework (Tutorial, How-to, Reference, Explanation) that separates content by user needs. Tutorials help beginners learn by doing, how-to guides solve specific problems, reference provides technical details, and explanation covers concepts and architecture. This structure matches what virtualenv uses and follows modern documentation best practices. Moved files to new directories (tutorial/, how-to/, reference/, plugin/), updated all cross-references, simplified the index page title, and added a utility script to automate future reference updates.
a3086f4 to
1c6db21
Compare
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 documentation was organized in a flat structure that mixed tutorials, how-to guides, reference material, and conceptual explanations together. Users had difficulty finding information appropriate to their skill level and immediate needs. 📚 New users couldn't distinguish between learning materials and quick reference, while experienced users had to wade through explanatory content to find technical specifications.
Adopted the Diátaxis documentation framework that organizes content by user needs rather than topics. The structure now separates Tutorial (learning-oriented), How-to guides (task-oriented), Reference (information-oriented), and Explanation (understanding-oriented). This matches the structure used by virtualenv and follows modern documentation best practices. Files were moved to appropriate directories, cross-references updated throughout, and installation documentation reorganized to use tabs for tool-specific details. Python compatibility specifications moved from installation guide to configuration reference where technical requirements belong.
The new structure makes it immediately clear where to look: beginners start with the tutorial, practitioners consult how-to guides for specific tasks, developers check reference for technical details, and everyone can deepen understanding through explanations when needed.