docs(diataxis): refine docs to strictly follow Diátaxis categories#341
Merged
Conversation
- Move explanation content out of how-to guides (console summary counts, order-prefix rationale, pipeline benefits) into links to the existing explanation pages - Add symptom-first Troubleshooting sections to split-descriptors and control-quotes how-to guides - Drop the hand-maintained --help dump from the CLI reference (drift-prone duplicate of the option table) and tighten the API reference intro - Update sample outputs to v0.6.0 / yamkix v1.1.0 - Reduce stale root CONTRIBUTING.md (poetry/asdf era) to a pointer to the up-to-date docs/contributing.md Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #341 +/- ##
=======================================
Coverage 79.14% 79.14%
=======================================
Files 11 11
Lines 235 235
Branches 28 28
=======================================
Hits 186 186
Misses 45 45
Partials 4 4 ☔ View full report in Codecov by Harness. |
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.
Summary
Refinement pass on the Diátaxis documentation introduced in #327: each page stays in its category, explanation content no longer leaks into how-to guides, and drift-prone duplication is removed.
Changes
how-it-works,ecosystem)invalidcount) and Control quotes (-Erequires-q)--helpdump from the CLI reference (duplicate of the option table, already drifting) and tightened the API reference introCONTRIBUTING.md: reduced the stale poetry/asdf-era copy to a pointer to the up-to-datedocs/contributing.mdTest plan
make build-docs— zero mkdocs validation warnings (links + anchors checked)Related to #327
🤖 Generated with Claude Code