b6529b548e
Consolidate completed/ and summaries/ into archive/ subdirectory, update all cross-references in README.md and compliance audit. Add multi-node blockchain workflow links to blockchain README. Remove broken governance best-practices link. Mark all priority document metadata checks as complete in compliance audit.
5.0 KiB
5.0 KiB
Documentation Compliance Audit
Level: All Levels
Prerequisites: Familiarity with the AITBC docs tree and template standard
Estimated Time: 15-20 minutes
Last Updated: 2026-04-27
Version: 1.0
🧭 Navigation Path:
🏠 Documentation Home → 📖 About → ✅ Compliance Audit → You are here
breadcrumb: Home → About → Compliance Audit
🎯 See Also:
- 📋 Template Standard - Required metadata and structure
- 🎯 10/10 Roadmap - Quality goals and remediation themes
- 📊 Organization Analysis - Historical structure review
- 🏠 Documentation Home - Main docs entry point
- 🧭 Master Index - Full documentation catalog
🎯 Audit Scope
This checklist tracks the current remediation target:
- missing top-level index pages
- standardized metadata on priority documents
- breadcrumbs and cross-links on high-traffic pages
- historical exceptions that should remain intentionally archived
- repeatable validation so docs do not drift again
✅ Top-Level Index Coverage
Required directory indexes
about/README.md11_agents/README.mdagent-sdk/README.mdadvanced/README.mdanalytics/README.mdapps/README.mdarchive/README.mdbackend/README.mdbeginner/README.mdblockchain/README.mdcompleted/README.mdcontracts/README.mddeployment/README.mddevelopment/README.mdexchange/README.mdexpert/README.mdgeneral/README.mdguides/README.mdgovernance/README.mdimplementation/README.mdinfrastructure/README.mdintermediate/README.mdmaintenance/README.mdmobile/README.mdnodes/README.mdopenclaw/README.mdpackages/README.mdpolicies/README.mdreference/README.mdreleases/README.mdreports/README.mdsecurity/README.mdsummaries/README.mdtrail/README.mdwebsite/README.mdworkflows/README.md
Documented exceptions
cli-technical/is a special external technical entry point with a compliant landing pagetesting/is a special external documentation entry point with a compliant landing page
✅ Priority Document Checks
Core docs entry points
docs/README.mdhasLevel,Prerequisites,Estimated Time,Last Updated,Versiondocs/README.mdhas a navigation path and breadcrumbdocs/README.mdlinks toMASTER_INDEX.mdand the core learning pathsdocs/beginner/README.mdhas standardized metadata and cross-linksdocs/intermediate/README.mdhas standardized metadata and cross-linksdocs/advanced/README.mdhas standardized metadata and cross-linksdocs/expert/README.mdhas standardized metadata and cross-linksdocs/project/README.mdhas standardized metadata and cross-linksdocs/apps/README.mdhas standardized metadata and cross-linksdocs/about/README.mdlinks to the template standard and audit checklist
Historical or special content
docs/archive/README.mdclearly marks archive content as historicaldocs/archive/completed/README.mdclearly marks completed work as historicaldocs/implementation/README.mdremains intentionally lightweight until a future cleanup pass
✅ Cross-Link Checks
- Root docs point at the current hierarchy, not obsolete paths
- Beginner, project, and app landing pages point at each other where appropriate
- About pages link back to the template standard and the audit checklist
- Release notes link from the master index and release index
- Policy and governance documents cross-reference each other cleanly
✅ Validation Steps
- Review the directory tree and confirm each top-level docs area has an index.
- Confirm priority docs include the template fields and navigation sections.
- Record exceptions instead of leaving them ambiguous.
- Re-run the docs validation workflow after making any navigation changes.
📝 Current Remediation Notes
- Historical content stays in place unless it is clearly duplicated or misleading.
- The goal is discoverability and consistency, not flattening every directory.
- The following directories now have landing pages added in this pass:
about/,deployment/,development/,guides/,governance/,mobile/,nodes/,policies/,reference/,releases/,reports/,summaries/,trail/, andworkflows/. - The project and apps landing pages now include template-compliant related resources and quality metrics sections.
- Any future docs area should either include a README index or be documented here as an intentional exception.
Last updated: 2026-04-27
Version: 1.0
Status: Audit checklist