docs-validation: reorganize archive structure and update master index references
Relocate completed projects and summaries into archive subdirectories, update MASTER_INDEX.md to reflect new archive organization with 156+ documents across 10 categories. Add cli-technical and testing README validation targets, expand priority docs metadata checks to include about, project, apps, cli-technical, and testing hubs. Implement master index structure validation to verify required section markers for applications
This commit is contained in:
aitbc
@@ -67,6 +67,7 @@ jobs:
|
||||
docs/blockchain/**/*.md
|
||||
docs/completed/**/*.md
|
||||
docs/contracts/**/*.md
|
||||
docs/cli-technical/README.md
|
||||
docs/deployment/**/*.md
|
||||
docs/development/**/*.md
|
||||
docs/exchange/**/*.md
|
||||
@@ -89,6 +90,7 @@ jobs:
|
||||
docs/security/**/*.md
|
||||
docs/summaries/**/*.md
|
||||
docs/trail/**/*.md
|
||||
docs/testing/README.md
|
||||
docs/website/**/*.md
|
||||
docs/workflows/**/*.md
|
||||
)
|
||||
@@ -119,11 +121,13 @@ jobs:
|
||||
docs/agent-sdk/README.md
|
||||
docs/apps/README.md
|
||||
docs/archive/README.md
|
||||
docs/archive/completed/README.md
|
||||
docs/archive/summaries/README.md
|
||||
docs/backend/README.md
|
||||
docs/beginner/README.md
|
||||
docs/completed/README.md
|
||||
docs/blockchain/README.md
|
||||
docs/contracts/README.md
|
||||
docs/cli-technical/README.md
|
||||
docs/deployment/README.md
|
||||
docs/development/README.md
|
||||
docs/exchange/README.md
|
||||
@@ -145,8 +149,8 @@ jobs:
|
||||
docs/releases/README.md
|
||||
docs/reports/README.md
|
||||
docs/security/README.md
|
||||
docs/summaries/README.md
|
||||
docs/trail/README.md
|
||||
docs/testing/README.md
|
||||
docs/website/README.md
|
||||
docs/workflows/README.md
|
||||
)
|
||||
@@ -161,6 +165,27 @@ jobs:
|
||||
fi
|
||||
done
|
||||
|
||||
- name: Validate master index structure
|
||||
run: |
|
||||
cd /var/lib/aitbc-workspaces/docs-validation/repo
|
||||
echo "=== Master Index Structure ==="
|
||||
|
||||
master_index_markers=(
|
||||
"## 📦 **Applications Documentation**"
|
||||
"## 🏠 **Main Documentation**"
|
||||
"## 🔗 **External Documentation (Symlinks)**"
|
||||
"## 🎯 **Topic-Specific Areas**"
|
||||
)
|
||||
|
||||
for marker in "${master_index_markers[@]}"; do
|
||||
if ! grep -qF "$marker" docs/MASTER_INDEX.md; then
|
||||
echo " ❌ docs/MASTER_INDEX.md missing required marker: $marker"
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
|
||||
echo "✅ Master index structure validated"
|
||||
|
||||
- name: Validate priority docs metadata
|
||||
run: |
|
||||
cd /var/lib/aitbc-workspaces/docs-validation/repo
|
||||
@@ -168,10 +193,14 @@ jobs:
|
||||
|
||||
priority_docs=(
|
||||
docs/README.md
|
||||
docs/MASTER_INDEX.md
|
||||
docs/about/README.md
|
||||
docs/beginner/README.md
|
||||
docs/intermediate/README.md
|
||||
docs/expert/README.md
|
||||
docs/project/README.md
|
||||
docs/apps/README.md
|
||||
docs/cli-technical/README.md
|
||||
docs/testing/README.md
|
||||
)
|
||||
|
||||
required_markers=(
|
||||
|
||||
@@ -160,11 +160,14 @@ Documentation about the documentation system itself:
|
||||
## 🗂️ **Archive & History**
|
||||
|
||||
### **📚 [Archive Documentation](archive/README.md)**
|
||||
**65 historical documents** organized in 7 categories:
|
||||
**156+ historical documents** organized in 10 categories:
|
||||
|
||||
| Category | Files | Content |
|
||||
|----------|-------|---------|
|
||||
| [📊 Analytics](archive/analytics/) | 6 files | AI agent communication analysis |
|
||||
| [📑 Summaries](archive/summaries/) | 42 files | Task completion summaries and handoffs |
|
||||
| [<EFBFBD> Completed](archive/completed/) | 8 subdirectories | Completed work and implemented plans |
|
||||
| [🧠 Expert](archive/expert/) | 4 subdirectories | Expert-level issues and completed phases |
|
||||
| [<EFBFBD> Analytics](archive/analytics/) | 6 files | AI agent communication analysis |
|
||||
| [🔧 Backend](archive/backend/) | 3 files | Backend system documentation |
|
||||
| [💻 CLI](archive/cli/) | 16 files | CLI implementation and testing |
|
||||
| [📋 Core Planning](archive/core_planning/) | 5 files | Planning and requirements |
|
||||
@@ -176,18 +179,18 @@ Documentation about the documentation system itself:
|
||||
|
||||
## ✅ **Completed Projects**
|
||||
|
||||
### **📋 [Completed Projects](completed/README.md)**
|
||||
**Project tracking and completion documentation:**
|
||||
### **📋 [Completed Projects](archive/completed/README.md)**
|
||||
**Project tracking and completion documentation (now in archive):**
|
||||
|
||||
| Category | Focus | Status |
|
||||
|----------|-------|--------|
|
||||
| [🔧 Backend](completed/backend/) | Backend implementations | Production-ready |
|
||||
| [💻 CLI](completed/cli/) | CLI enhancements | Integrated |
|
||||
| [📋 Core Planning](completed/core_planning/) | Architecture work | Implemented |
|
||||
| [🏗️ Infrastructure](completed/infrastructure/) | Infrastructure projects | Operational |
|
||||
| [🔒 Security](completed/security/) | Security initiatives | Deployed |
|
||||
| [📊 Summaries](completed/summaries/) | Project overviews | Documentation complete |
|
||||
| [🛠️ Maintenance](completed/maintenance/) | System improvements | Validated |
|
||||
| [🔧 Backend](archive/completed/backend/) | Backend implementations | Production-ready |
|
||||
| [💻 CLI](archive/completed/cli/) | CLI enhancements | Integrated |
|
||||
| [📋 Core Planning](archive/completed/core_planning/) | Architecture work | Implemented |
|
||||
| [🏗️ Infrastructure](archive/completed/infrastructure/) | Infrastructure projects | Operational |
|
||||
| [🔒 Security](archive/completed/security/) | Security initiatives | Deployed |
|
||||
| [📊 Summaries](archive/completed/summaries/) | Project overviews | Documentation complete |
|
||||
| [🛠️ Maintenance](archive/completed/maintenance/) | System improvements | Validated |
|
||||
|
||||
---
|
||||
|
||||
@@ -230,7 +233,6 @@ Contract, node, and website documentation now live in local docs indexes under `
|
||||
| [📖 Reference](reference/README.md) | Compact lookup and reference docs | Active |
|
||||
| [📋 Releases](releases/README.md) | Release notes and version history | Active |
|
||||
| [📊 Reports](reports/README.md) | Status, quality, and completion reports | Active |
|
||||
| [📑 Summaries](summaries/README.md) | Outcome summaries and handoffs | Active |
|
||||
| [🧵 Trail](trail/README.md) | Operational breadcrumbs and success notes | Active |
|
||||
| [🧩 OpenClaw](openclaw/README.md) | OpenClaw agent integration documentation | Active |
|
||||
| [🌐 Website](website/) | Rendered documentation site assets | Active |
|
||||
|
||||
@@ -44,7 +44,19 @@ The archive is organized by content categories for easy access:
|
||||
- **Topics**: Completed phases, 2026-02 issues, port migrations, other resolved issues
|
||||
- **Relevance**: Expert-level task completion history
|
||||
|
||||
### **📚 General** (`/general/`)
|
||||
### **<EFBFBD> Completed** (`/completed/`)
|
||||
- **Content**: Completed work and implemented plans
|
||||
- **Files**: 8 subdirectories
|
||||
- **Topics**: Backend, CLI, core planning, implementation, infrastructure, maintenance, security, summaries
|
||||
- **Relevance**: Project completion history
|
||||
|
||||
### **📑 Summaries** (`/summaries/`)
|
||||
- **Content**: Task completion summaries and handoffs
|
||||
- **Files**: 42 documents
|
||||
- **Topics**: CLI fixes, testing, OpenClaw, project organization, WebSocket backpressure
|
||||
- **Relevance**: Task completion tracking
|
||||
|
||||
### **<2A> General** (`/general/`)
|
||||
- **Content**: General project documentation
|
||||
- **Files**: 16 documents
|
||||
- **Topics**: Milestone tracking, current issues, comprehensive archives
|
||||
@@ -104,26 +116,28 @@ The archive is organized by content categories for easy access:
|
||||
## 📊 **Archive Statistics:**
|
||||
|
||||
```
|
||||
Total Files: 106+ documents
|
||||
Total Categories: 8 categories
|
||||
Largest Category: Expert (completed_phases: 22 files)
|
||||
Total Files: 156+ documents
|
||||
Total Categories: 10 categories
|
||||
Largest Category: Summaries (42 files)
|
||||
Smallest Category: Backend (3 files)
|
||||
Average Files per Category: 13.3 files
|
||||
Average Files per Category: 15.6 files
|
||||
```
|
||||
|
||||
### **File Distribution:**
|
||||
- **Summaries**: 42 files (26.9%)
|
||||
- **Completed**: 8 subdirectories (50+ files total)
|
||||
- **Expert**: 4 subdirectories (41+ files total)
|
||||
- completed_phases: 22 files
|
||||
- 2026-02-issues: 10 files
|
||||
- other-issues: 5 files
|
||||
- port-migrations: 4 files
|
||||
- **General**: 16 files (15.1%)
|
||||
- **CLI**: 16 files (15.1%)
|
||||
- **Infrastructure**: 10 files (9.4%)
|
||||
- **Security**: 7 files (6.6%)
|
||||
- **Analytics**: 6 files (5.7%)
|
||||
- **Core Planning**: 5 files (4.7%)
|
||||
- **Backend**: 3 files (2.8%)
|
||||
- **General**: 16 files (10.3%)
|
||||
- **CLI**: 16 files (10.3%)
|
||||
- **Infrastructure**: 10 files (6.4%)
|
||||
- **Security**: 7 files (4.5%)
|
||||
- **Analytics**: 6 files (3.8%)
|
||||
- **Core Planning**: 5 files (3.2%)
|
||||
- **Backend**: 3 files (1.9%)
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@
|
||||
## 🎯 **See Also:**
|
||||
- **🌉 Previous Level**: [Advanced Documentation](../advanced/README.md) - Deep technical content
|
||||
- **📚 Archive Research**: [Archive Documentation](../archive/README.md) - Historical research materials
|
||||
- **✅ Completed Projects**: [Completed Projects](../completed/README.md) - Project completion tracking
|
||||
- **✅ Completed Projects**: [Completed Projects](../archive/completed/README.md) - Project completion tracking
|
||||
- **📖 Documentation Standards**: [About Documentation](../about/README.md) - Template guidance and audit checklist
|
||||
- **📋 Project Info**: [Project Documentation](../project/) - Project overview
|
||||
|
||||
@@ -24,7 +24,7 @@
|
||||
- **🔍 Issue Resolution**: [Expert Issues](01_issues/) → [Advanced Security](../advanced/06_security/)
|
||||
- **📊 Task Management**: [Expert Tasks](02_tasks/) → [Intermediate Planning](../intermediate/01_planning/)
|
||||
- **🔄 Workflow**: [Expert Workflow](06_workflow/) → [Advanced Architecture](../advanced/03_architecture/)
|
||||
- **📈 Reports**: [Expert Reports](05_reports/) → [Project Summaries](../summaries/)
|
||||
- **📈 Reports**: [Expert Reports](05_reports/) → [Project Summaries](../archive/summaries/)
|
||||
|
||||
This section contains specialized, in-depth content for experts who want to master specific aspects of the AITBC ecosystem. These topics assume deep technical knowledge and focus on advanced concepts, research, and cutting-edge developments.
|
||||
|
||||
|
||||
@@ -22,7 +22,7 @@ Comprehensive analysis confirms core wallet operations are fully functional and
|
||||
1) **Smoke integration checks**: Run end-to-end CLI sanity tests across exchange, oracle, and market-making commands; file any regressions.
|
||||
2) **Automated health check**: Schedule nightly run of master planning cleanup + doc health check to keep `docs/10_plan` marker-free and docs indexed.
|
||||
3) **Docs visibility**: Publish the new `DOCUMENTATION_INDEX.md` and category READMEs to the team; ensure links from the roadmap.
|
||||
4) **Archive sync**: Verify `docs/completed/` mirrors recent moves; remove any stragglers left in `docs/10_plan`.
|
||||
4) **Archive sync**: Verify `docs/archive/completed/` mirrors recent moves; remove any stragglers left in `docs/10_plan`.
|
||||
5) **Monitoring alert sanity**: Confirm monitoring alerts for exchange/oracle services trigger and resolve correctly with test incidents.
|
||||
|
||||
Previous focus areas for Q2 2026 - **NOW COMPLETED**:
|
||||
|
||||
@@ -71,16 +71,16 @@ System maintenance and requirements
|
||||
- `debian13-trixie-support-update.md` - Debian 13 support updates
|
||||
- `ubuntu-removal-summary.md` - Ubuntu removal procedures
|
||||
|
||||
### 📊 [10_summaries/](./10_summaries/)
|
||||
Project summaries and current issues
|
||||
- `priority-3-complete.md` - Priority 3 completion report (10537 bytes)
|
||||
- `99_currentissue.md` - Current issues and blockers (30364 bytes)
|
||||
### 📊 [Summaries](../../archive/summaries/)
|
||||
- **Content**: High-level summaries and current issues
|
||||
- **Topics**: Project status, critical gaps, implementation summaries
|
||||
- **Relevance**: Quick access to project status and issues and blockers (30364 bytes)
|
||||
|
||||
## 📋 Quick Access
|
||||
|
||||
### Most Important Documents
|
||||
1. **Exchange Infrastructure Plan**: `02_implementation/exchange-infrastructure-implementation.md` - Critical 40% gap resolution
|
||||
2. **Current Issues**: `10_summaries/99_currentissue_exchange-gap.md` - Active implementation gaps
|
||||
2. **Current Issues**: `../../archive/summaries/99_currentissue_exchange-gap.md` - Active implementation gaps
|
||||
3. **Next Milestone**: `01_core_planning/00_nextMileston.md` - Updated with exchange focus
|
||||
4. **Implementation Status**: `02_implementation/backend-implementation-status.md` - Current progress
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
- **🏠 [Documentation Home](../README.md)** - Main docs entry point
|
||||
- **📚 [Master Index](../MASTER_INDEX.md)** - Full documentation catalog
|
||||
- **📖 [About Documentation](../about/README.md)** - Standards and compliance context
|
||||
- **✅ [Completed Projects](../completed/README.md)** - Completion tracking and summaries
|
||||
- **✅ [Completed Projects](../archive/completed/README.md)** - Completion tracking and summaries
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -17,7 +17,7 @@
|
||||
- **📚 [About Documentation](../about/README.md)** - Documentation standards and audit notes
|
||||
- **🏠 [Documentation Home](../README.md)** - Main docs entry point
|
||||
- **🧭 [Master Index](../MASTER_INDEX.md)** - Full documentation catalog
|
||||
- **✅ [Completed Projects](../completed/README.md)** - Completion tracking and final summaries
|
||||
- **✅ [Completed Projects](../archive/completed/README.md)** - Completion tracking and final summaries
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user