Skip to content

fix(docs): fix Diátaxis mode violations in concepts and how-to#41

Merged
beonde merged 2 commits into
mainfrom
fix/docs-p2-diataxis
May 2, 2026
Merged

fix(docs): fix Diátaxis mode violations in concepts and how-to#41
beonde merged 2 commits into
mainfrom
fix/docs-p2-diataxis

Conversation

@beonde
Copy link
Copy Markdown
Member

@beonde beonde commented May 2, 2026

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)

  • Before: 420-line reference document with error codes, output format specs, performance benchmarks, internal process docs
  • After: 60-line concept page explaining what validation is, what categories are checked, and when to validate
  • Moved content: Full reference → reference/cli/validation.md

how-to/security/policy-enforcement.md (trimmed)

  • Removed: Configuration reference table (12 env vars), PDP request/response JSON format
  • Moved to: reference/server/policy-enforcement.md
  • Kept: All step-by-step procedural content (Options A/B, break-glass setup, verification)

New reference pages

  • reference/cli/validation.md — Complete validation internals, error codes, output formats
  • reference/server/policy-enforcement.md — PEP/PDP config, enforcement mode matrix, request format, telemetry fields

Navigation

  • Added Validation Reference under CapiscIO Core in nav
  • Added Policy Enforcement under Server API in nav

Verification

  • mkdocs build --strict passes
  • No content lost — all reference material preserved in new locations
  • Cross-links between how-to ↔ reference pages working

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.
@beonde beonde force-pushed the fix/docs-p2-diataxis branch from 17450ab to faeabc7 Compare May 2, 2026 18:51
@beonde beonde merged commit 2b25d3a into main May 2, 2026
4 checks passed
@beonde beonde deleted the fix/docs-p2-diataxis branch May 2, 2026 18:56
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 2, 2026

✅ Documentation Build Successful

The documentation build completed successfully and passed validation checks.

  • ✅ Build completed without errors
  • ✅ Critical files present (index.html, sitemap.xml, robots.txt)
  • ✅ Link validation completed

This PR will deploy to dev-docs.capisc.io when merged to main.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant