docs-validation: expand curated markdown scope to include all documentation hubs
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
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
This commit is contained in:
50
docs/guides/README.md
Normal file
50
docs/guides/README.md
Normal file
@@ -0,0 +1,50 @@
|
||||
# Documentation Guides
|
||||
|
||||
**Level**: All Levels
|
||||
**Prerequisites**: None
|
||||
**Estimated Time**: 10-15 minutes
|
||||
**Last Updated**: 2026-04-27
|
||||
**Version**: 1.0
|
||||
|
||||
## 🧭 **Navigation Path:**
|
||||
**🏠 [Documentation Home](../README.md)** → **📚 Guides** → *You are here*
|
||||
|
||||
**breadcrumb**: Home → Guides → Overview
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **See Also:**
|
||||
- **🏠 [Documentation Home](../README.md)** - Main docs landing page
|
||||
- **🧭 [Master Index](../MASTER_INDEX.md)** - Complete docs catalog
|
||||
- **📋 [Template Standard](../about/DOCUMENTATION_TEMPLATE_STANDARD.md)** - Writing standard for docs
|
||||
- **✅ [Compliance Audit](../about/DOCUMENTATION_COMPLIANCE_AUDIT.md)** - Documentation checklist
|
||||
|
||||
---
|
||||
|
||||
## 📦 **Contents**
|
||||
|
||||
- **[README_DOCUMENTATION.md](README_DOCUMENTATION.md)** - Documentation authoring guide and structure notes
|
||||
|
||||
---
|
||||
|
||||
## 🧱 **Purpose**
|
||||
|
||||
This directory centralizes guide-style documentation that helps contributors and readers:
|
||||
|
||||
- understand how the docs are organized
|
||||
- follow the repository documentation standard
|
||||
- navigate to the right learning or reference area
|
||||
|
||||
---
|
||||
|
||||
## 🚀 **Next Steps**
|
||||
|
||||
- Start with `README_DOCUMENTATION.md` if you need to write or revise docs.
|
||||
- Review `../about/DOCUMENTATION_TEMPLATE_STANDARD.md` before editing high-traffic docs.
|
||||
- Use `../about/DOCUMENTATION_COMPLIANCE_AUDIT.md` to check for drift.
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2026-04-27*
|
||||
*Version: 1.0*
|
||||
*Status: Guide index*
|
||||
@@ -163,7 +163,7 @@ For detailed structure information, see [PROJECT_STRUCTURE.md](docs/PROJECT_STRU
|
||||
|
||||
## ⚡ **Recent Improvements (March 2026)**
|
||||
|
||||
### **<EFBFBD> Code Quality Excellence**
|
||||
### **🧩 Code Quality Excellence**
|
||||
- **Pre-commit Hooks**: Automated quality checks on every commit
|
||||
- **Black Formatting**: Consistent code formatting across all files
|
||||
- **Type Checking**: Comprehensive MyPy implementation with CI/CD integration
|
||||
@@ -587,7 +587,7 @@ git push origin feature/amazing-feature
|
||||
- **🎓 Advanced AI Teaching Plan**: 100% complete (3 phases, 6 sessions)
|
||||
- **🤖 OpenClaw Agent Mastery**: Advanced AI specialists with real-world capabilities
|
||||
- **📚 Perfect Documentation**: 10/10 quality score achieved
|
||||
- **<EFBFBD> Production Ready**: Fully operational blockchain infrastructure
|
||||
- **🚀 Production Ready**: Fully operational blockchain infrastructure
|
||||
- **⚡ Advanced AI Operations**: Complex workflow orchestration, multi-model pipelines, resource optimization
|
||||
|
||||
### **🎯 Real-World Applications:**
|
||||
@@ -610,7 +610,7 @@ git push origin feature/amazing-feature
|
||||
|
||||
---
|
||||
|
||||
## <EFBFBD>📄 **License**
|
||||
## 📄 **License**
|
||||
|
||||
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE) file for details.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user