fix(docs): fix Diátaxis mode violations in concepts and how-to#41
Merged
Conversation
P2-3: Extract reference-mode content from concept and how-to pages. - concepts/validation.md: Was a full reference doc (error codes, internals, output formats). Replaced with a proper concept page explaining what validation is and why it matters. Full reference moved to reference/cli/validation.md. - how-to/security/policy-enforcement.md: Configuration reference table and PDP request/response format extracted to new reference/server/policy-enforcement.md. How-to now links to reference for non-procedural details. - mkdocs.yml: Added nav entries for new reference pages.
17450ab to
faeabc7
Compare
✅ 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.
Summary
Fix Diátaxis framework violations by separating reference-mode content from concept and how-to pages.
Documentation Audit Reference
Phase: P2-3
Severity: Medium
Changes
concepts/validation.md (rewritten)
reference/cli/validation.mdhow-to/security/policy-enforcement.md (trimmed)
reference/server/policy-enforcement.mdNew reference pages
reference/cli/validation.md— Complete validation internals, error codes, output formatsreference/server/policy-enforcement.md— PEP/PDP config, enforcement mode matrix, request format, telemetry fieldsNavigation
Validation Referenceunder CapiscIO Core in navPolicy Enforcementunder Server API in navVerification
mkdocs build --strictpasses