From b6529b548e7057fd4a43e74f32dde2b614e4b3b2 Mon Sep 17 00:00:00 2001 From: aitbc Date: Mon, 27 Apr 2026 12:13:02 +0200 Subject: [PATCH] docs: update archive structure references and mark priority docs as complete 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. --- docs/README.md | 12 +++++------ docs/about/DOCUMENTATION_COMPLIANCE_AUDIT.md | 22 ++++++++++---------- docs/blockchain/README.md | 11 ++++++++++ docs/governance/openclaw-dao-governance.md | 1 - 4 files changed, 27 insertions(+), 19 deletions(-) diff --git a/docs/README.md b/docs/README.md index 7bb17d5f..33a9b7d6 100644 --- a/docs/README.md +++ b/docs/README.md @@ -101,8 +101,7 @@ ├── intermediate/ # Bridge to advanced ├── advanced/ # Deep technical content ├── expert/ # Specialized expertise -├── archive/ # Historical documents -├── completed/ # Finished projects +├── archive/ # Historical documents (includes completed/ and summaries/) ├── contracts/ # Smart contract verification docs ├── website/ # Rendered website documentation assets ├── nodes/ # Node operations notes and commands @@ -112,7 +111,6 @@ ├── reference/ # Compact lookup/reference docs ├── releases/ # Versioned release notes ├── reports/ # Status, quality, and completion reports -├── summaries/ # Outcome summaries and handoffs ├── trail/ # Operational breadcrumbs and success notes ├── workflows/ # Documentation workflow outcomes ``` @@ -200,12 +198,12 @@ Files are now organized with systematic prefixes based on reading level: - **✅ Compliance Audit**: [Docs Compliance Checklist](about/DOCUMENTATION_COMPLIANCE_AUDIT.md) - **🎯 Quality Roadmap**: [10/10 Quality Plan](about/DOCS_10_10_ROADMAP.md) - **🗂️ Archive Guide**: [Archive Organization](archive/README.md) -- **✅ Completed Projects**: [Project Completion Tracking](completed/README.md) +- **✅ Completed Projects**: [Project Completion Tracking](archive/completed/README.md) - **🚀 Deployment**: [Deployment Documentation](deployment/README.md) - **📖 Reference**: [Reference Documentation](reference/README.md) - **📋 Releases**: [Release Notes](releases/README.md) - **📊 Reports**: [Reports Documentation](reports/README.md) -- **📑 Summaries**: [Summaries Documentation](summaries/README.md) +- **📑 Summaries**: [Summaries Documentation](archive/summaries/README.md) - **🧵 Trail**: [Trail Documentation](trail/README.md) - **🔄 Workflows**: [Workflows Documentation](workflows/README.md) @@ -255,8 +253,8 @@ Files are now organized with systematic prefixes based on reading level: ### 📊 **Project Documentation:** - **📋 Project Overview**: [Project Documentation](project/) - Project information -- **✅ Completed Work**: [Completed Projects](completed/) - Finished tasks -- **📈 Summaries**: [Project Summaries](summaries/) - Project summaries +- **✅ Completed Work**: [Completed Projects](archive/completed/) - Finished tasks +- **📈 Summaries**: [Project Summaries](archive/summaries/) - Project summaries - **🔄 Workflows**: [Workflows](workflows/) - Development workflows ### 🆘 **Help & Support:** diff --git a/docs/about/DOCUMENTATION_COMPLIANCE_AUDIT.md b/docs/about/DOCUMENTATION_COMPLIANCE_AUDIT.md index 715f4af1..a102a410 100644 --- a/docs/about/DOCUMENTATION_COMPLIANCE_AUDIT.md +++ b/docs/about/DOCUMENTATION_COMPLIANCE_AUDIT.md @@ -83,21 +83,21 @@ This checklist tracks the current remediation target: ## ✅ **Priority Document Checks** ### Core docs entry points -- [ ] `docs/README.md` has `Level`, `Prerequisites`, `Estimated Time`, `Last Updated`, `Version` -- [ ] `docs/README.md` has a navigation path and breadcrumb -- [ ] `docs/README.md` links to `MASTER_INDEX.md` and the core learning paths -- [ ] `docs/beginner/README.md` has standardized metadata and cross-links -- [ ] `docs/intermediate/README.md` has standardized metadata and cross-links -- [ ] `docs/advanced/README.md` has standardized metadata and cross-links -- [ ] `docs/expert/README.md` has standardized metadata and cross-links +- [x] `docs/README.md` has `Level`, `Prerequisites`, `Estimated Time`, `Last Updated`, `Version` +- [x] `docs/README.md` has a navigation path and breadcrumb +- [x] `docs/README.md` links to `MASTER_INDEX.md` and the core learning paths +- [x] `docs/beginner/README.md` has standardized metadata and cross-links +- [x] `docs/intermediate/README.md` has standardized metadata and cross-links +- [x] `docs/advanced/README.md` has standardized metadata and cross-links +- [x] `docs/expert/README.md` has standardized metadata and cross-links - [x] `docs/project/README.md` has standardized metadata and cross-links - [x] `docs/apps/README.md` has standardized metadata and cross-links -- [ ] `docs/about/README.md` links to the template standard and audit checklist +- [x] `docs/about/README.md` links to the template standard and audit checklist ### Historical or special content -- [ ] `docs/archive/README.md` clearly marks archive content as historical -- [ ] `docs/completed/README.md` clearly marks completed work as historical -- [ ] `docs/implementation/README.md` remains intentionally lightweight until a future cleanup pass +- [x] `docs/archive/README.md` clearly marks archive content as historical +- [x] `docs/archive/completed/README.md` clearly marks completed work as historical +- [x] `docs/implementation/README.md` remains intentionally lightweight until a future cleanup pass --- diff --git a/docs/blockchain/README.md b/docs/blockchain/README.md index 8c91ab10..1d31e994 100644 --- a/docs/blockchain/README.md +++ b/docs/blockchain/README.md @@ -9,6 +9,17 @@ - [Adding gitea-runner as Third Blockchain Node (aitbc2)](adding_gitea_runner_as_third_node.md) - Complete guide for adding a third node to the AITBC blockchain network, including configuration steps, issues encountered, and verification procedures. - [Blockchain Synchronization Issues and Fixes](blockchain_synchronization_issues_and_fixes.md) - Documentation of synchronization issues between AITBC nodes and their resolutions. +## Multi-Node Blockchain Workflows + +Comprehensive Windsurf workflows for multi-node blockchain deployment and operations: + +- **[Core Setup](../../.windsurf/workflows/multi-node-blockchain-setup-core.md)** - Prerequisites, environment configuration, and basic node setup +- **[Operations](../../.windsurf/workflows/multi-node-blockchain-operations.md)** - Daily operations, monitoring, and troubleshooting +- **[Advanced Features](../../.windsurf/workflows/multi-node-blockchain-advanced.md)** - Smart contracts, security testing, and performance optimization +- **[Marketplace Testing](../../.windsurf/workflows/multi-node-blockchain-marketplace.md)** - GPU provider testing, transaction tracking, and verification procedures +- **[Production Deployment](../../.windsurf/workflows/multi-node-blockchain-production.md)** - Security hardening, monitoring, and scaling strategies +- **[Reference](../../.windsurf/workflows/multi-node-blockchain-reference.md)** - Configuration overview, verification commands, and best practices + ## Transaction Types The AITBC blockchain supports the following transaction types: diff --git a/docs/governance/openclaw-dao-governance.md b/docs/governance/openclaw-dao-governance.md index d7c7f096..2761760d 100644 --- a/docs/governance/openclaw-dao-governance.md +++ b/docs/governance/openclaw-dao-governance.md @@ -430,7 +430,6 @@ Governance Integration: ### **Community Resources** - [DAO Participation Guide](../community/guide.md) - [Agent Development Tutorial](../development/agent-tutorial.md) -- [Governance Best Practices](../governance/best-practices.md) - [FAQ and Support](../community/faq.md) ---