You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs/ARCHITECTURE.md contains security and capability claims that don't match the current implementation. This directly damages credibility with contributors and security auditors — and is specifically flagged by OpenSSF Scorecard reviewers who read documentation.
Known gaps (documented in ENHANCEMENT_ROADMAP.md itself):
Add status matrix table (above) to top of ARCHITECTURE.md
Change "AES-256-GCM encryption" heading to "Vault Encryption (see status matrix)"
Add note: "Symbolic Planner uses greedy forward search, not PDDL. PDDL integration is planned."
Fix any broken Mermaid diagrams (if present)
Add "Architecture Accuracy" notice at top:
> ⚠️ **Accuracy Notice:** Architecture descriptions reflect the design vision.> See the Implementation Status matrix below for current feature completeness.> Claims marked 🔲 Planned are aspirational and not yet implemented.
Fix README.md
Add prominent Project Status badge section near top:
Create docs/CONTRIBUTING-SECURITY.md for security-focused contributions
Ensure no doc file claims a feature without cross-referencing the status matrix
Continuous Accuracy
Add docs accuracy as a required PR checklist item in .github/PULL_REQUEST_TEMPLATE.md:
## Documentation-[ ] ARCHITECTURE.md status matrix updated if feature status changed
-[ ] README claims match implemented code
-[ ] New features marked 🔲 Planned until tests pass
Acceptance Criteria
✅ docs/ARCHITECTURE.md contains status matrix with accurate Implemented/Partial/Planned labels
✅ README has status badges for CI, coverage, and Scorecard
✅ README does not claim any unimplemented feature as complete
✅ SECURITY.md has vulnerability reporting timeline and supported versions
✅ PR template requires docs accuracy check
✅ All internal links in docs/ and README.md resolve without 404
Why This Matters Beyond Trust
OpenSSF Scorecard's Maintained check looks at activity and responsiveness. Accurate docs demonstrate project maturity. Security auditors who find documentation mismatches will rate the project as untrustworthy regardless of code quality. Since OBLISK is positioned as a security framework, documentation accuracy is a security property, not just a UX concern.
Dependencies
Requires: Nothing (doc edits are safe to merge any time) Should be updated when:#7, #8, #9, #10, #12, #13 merge Estimated effort: 3-4 hours initial + 30 min per feature PR
Problem
docs/ARCHITECTURE.mdcontains security and capability claims that don't match the current implementation. This directly damages credibility with contributors and security auditors — and is specifically flagged by OpenSSF Scorecard reviewers who read documentation.Known gaps (documented in ENHANCEMENT_ROADMAP.md itself):
Tasks
Audit Phase
docs/ARCHITECTURE.mdand cross-reference with actual source codeREADME.mdand verify accuracydocs/links referenced in README actually existDocumentation Status Matrix (add to ARCHITECTURE.md)
Fix ARCHITECTURE.md
Fix README.md
Fix SECURITY.md
Docs Directory Audit
docs/— verify each is linked and currentdocs/SECURITY-MODEL.mdexplaining vault trust boundariesdocs/CONTRIBUTING-SECURITY.mdfor security-focused contributionsContinuous Accuracy
.github/PULL_REQUEST_TEMPLATE.md:Acceptance Criteria
docs/ARCHITECTURE.mdcontains status matrix with accurate Implemented/Partial/Planned labelsWhy This Matters Beyond Trust
OpenSSF Scorecard's Maintained check looks at activity and responsiveness. Accurate docs demonstrate project maturity. Security auditors who find documentation mismatches will rate the project as untrustworthy regardless of code quality. Since OBLISK is positioned as a security framework, documentation accuracy is a security property, not just a UX concern.
Dependencies
Requires: Nothing (doc edits are safe to merge any time)
Should be updated when: #7, #8, #9, #10, #12, #13 merge
Estimated effort: 3-4 hours initial + 30 min per feature PR
Priority: P1
Labels: documentation, security, accuracy, P1