docs: restructure template and root docs to Diataxis folder-per-quadrant#122
Merged
Conversation
Reorganize generated project documentation into canonical Diataxis folders: - pages/tutorials/ (getting-started, examples) - pages/how-to/ (configure, troubleshooting, contribute) - pages/reference/ (api) - pages/explanation/ (concepts) Also restructure root repo docs (quickstart -> tutorials/) and update all cross-references in hooks.py, mkdocs.yml, index.md, tests, and skills.
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.
Description
Restructure generated project and root repo documentation into Diataxis folder-per-quadrant layout:
pages/tutorials/,pages/how-to/,pages/reference/,pages/explanation/.Type of Change
Motivation and Context
Generated projects had flat doc pages (
pages/getting-started.md,pages/user-guide.md, etc.) which made Diataxis quadrant boundaries unclear and harder to extend. This restructures into folder-per-quadrant so projects add new pages by dropping files into the correct folder.How Has This Been Tested?
uv run pytestcopier copy . /tmp/test-projectChecklist