chore(docs): Phase 2 — Restructure for clarity (Diátaxis cleanup)#27
Merged
chore(docs): Phase 2 — Restructure for clarity (Diátaxis cleanup)#27
Conversation
✅ Documentation Build SuccessfulThe documentation build completed successfully and passed validation checks.
|
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.
Phase 2: Restructure for Clarity
Part of the docs audit remediation plan. Phase 1 (fix critical code drift) was merged in PR #26.
What this PR does
Structural cleanup following the Diátaxis documentation framework — concept pages should explain, not instruct. Tutorial content belongs in Getting Started, how-to content in How-To Guides.
Changes
Navigation (
mkdocs.yml)Samplesfrom top-level nav → under Getting StartedLanding page (
docs/index.md)hide: navigation/hide: toc)Getting Started (
docs/getting-started/index.md)Concept pages — enforce explanation mode:
identity/index.md: Remove tutorial duplication (setup path cards, "Using Your Identity" section) — add cross-reference to Getting Startedtrust/index.md: Remove "Developer Experience" section containing ghost APIs (badge_pathparam,guard.client(),@guard.protect— none exist onSimpleGuard)scoring.md: Replace verbose CLI/Python how-to sections and stale migration guide with compact cross-references to CLI and SDK reference pagesvalidation.md: Remove non-existent "Conservative Mode" section (onlyprogressiveandstrictmodes exist in source code — verified incapiscio-core/pkg/scoring/engine.go)Net effect
Verification
mkdocs buildpasses cleanly (no new warnings)