96088f4501
Some checks failed
API Endpoint Tests / test-api-endpoints (push) Successful in 46s
CLI Tests / test-cli (push) Failing after 2s
Documentation Validation / validate-docs (push) Failing after 9s
Documentation Validation / validate-policies-strict (push) Failing after 12s
Package Tests / Python package - aitbc-agent-sdk (push) Successful in 24s
Package Tests / Python package - aitbc-core (push) Successful in 19s
Package Tests / Python package - aitbc-crypto (push) Successful in 10s
Package Tests / Python package - aitbc-sdk (push) Successful in 16s
Package Tests / JavaScript package - aitbc-sdk-js (push) Successful in 5s
Package Tests / JavaScript package - aitbc-token (push) Successful in 10s
Production Tests / Production Integration Tests (push) Successful in 17s
Python Tests / test-python (push) Successful in 8s
Security Scanning / security-scan (push) Successful in 46s
Multi-Node Blockchain Health Monitoring / health-check (push) Failing after 3s
Integration Tests / test-service-integration (push) Failing after 11m28s
Add all documentation subdirectories to the curated markdown linting targets, replacing the previous exclusion-based approach with comprehensive coverage. Update validation to check for required README files across all hubs and verify priority documentation metadata markers. Implement lazy loading for optional dependencies (numpy, redis, bcrypt, jwt, websockets) in agent-coordinator and related modules to improve startup
48 lines
1.7 KiB
Markdown
48 lines
1.7 KiB
Markdown
# About Documentation
|
|
|
|
**Level**: All Levels
|
|
**Prerequisites**: Familiarity with the AITBC documentation tree
|
|
**Estimated Time**: 10-20 minutes
|
|
**Last Updated**: 2026-04-27
|
|
**Version**: 1.0
|
|
|
|
## 🧭 **Navigation Path:**
|
|
**🏠 [Documentation Home](../README.md)** → **📖 About** → *You are here*
|
|
|
|
**breadcrumb**: Home → About → Overview
|
|
|
|
---
|
|
|
|
## 🎯 **See Also:**
|
|
- **📋 [Template Standard](DOCUMENTATION_TEMPLATE_STANDARD.md)** - Required structure for priority documents
|
|
- **🎯 [10/10 Roadmap](DOCS_10_10_ROADMAP.md)** - Quality goals and improvement areas
|
|
- **📊 [Organization Analysis](DOCS_ORGANIZATION_ANALYSIS.md)** - Historical structure review
|
|
- **🗂️ [Archive Structure Fix](ARCHIVE_STRUCTURE_FIX.md)** - Archive reorganization notes
|
|
- **📚 [Centralized Docs Structure](CENTRALIZED_DOCS_STRUCTURE.md)** - Central docs layout history
|
|
- **✅ [Documentation Compliance Audit](DOCUMENTATION_COMPLIANCE_AUDIT.md)** - Current remediation checklist
|
|
|
|
---
|
|
|
|
## 📚 **What lives here**
|
|
|
|
This directory contains the meta-documentation for the AITBC docs system:
|
|
|
|
- standards for writing and organizing documentation
|
|
- structural analyses and remediation notes
|
|
- documentation quality and navigation guidance
|
|
- compliance checks that keep the tree from drifting
|
|
|
|
---
|
|
|
|
## 🔎 **Key References**
|
|
|
|
- **Template baseline**: Use `DOCUMENTATION_TEMPLATE_STANDARD.md` for top-level and high-traffic docs.
|
|
- **Navigation baseline**: Keep links synchronized with `docs/README.md` and `docs/MASTER_INDEX.md`.
|
|
- **Audit baseline**: Review `DOCUMENTATION_COMPLIANCE_AUDIT.md` before adding new top-level docs.
|
|
|
|
---
|
|
|
|
*Last updated: 2026-04-27*
|
|
*Version: 1.0*
|
|
*Status: Meta-documentation hub*
|