Pattern Proposal: Documentation-as-Code Portal Projection

Summary

Compiles structured domain outputs and governance diagrams into a versioned, static documentation portal using MkDocs and client-side visualization scripts.

Candidate Pattern

• ID: docs-as-code-portal-projection
• Classification: architectural
• Maturity: established
• Type: implemented

Observed Signals

No specific signals listed.

Evidence

Supporting Evidence

• pyproject.toml (mkdocs, mkdocs-material, mkdocs-drawio) - Tooling dependencies supporting static architectural portal generation.
• portal/docs/static/js/dashboard.js - Client-side interactive visualization script for portal dashboard metrics.
• .github/workflows/cas-portal-publish.yml - CI deployment pipeline compiling and publishing the static portal.

Scope Assessment

• Evidence Strength: high
• Confidence: high
• Applies to: ideas-to-life-cas

Rationale

• Intent: Project architectural health and compliance state into an accessible, searchable developer portal without requiring a dedicated dynamic web backend.
• Context: Architectural guidelines and live compliance metrics need to be transparent to engineering teams without running specialized hosting servers.
• Force: Static hosting convenience (e.g. GitHub Pages)
• Force: Combining human-authored markdown with machine-generated governance dashboards

Traceability

Artifact source: proposed-patterns