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:
54
docs/development/README.md
Normal file
54
docs/development/README.md
Normal file
@@ -0,0 +1,54 @@
|
||||
# Development Documentation
|
||||
|
||||
**Level**: Intermediate
|
||||
**Prerequisites**: Familiarity with the AITBC codebase and local dev workflow
|
||||
**Estimated Time**: 20-30 minutes
|
||||
**Last Updated**: 2026-04-27
|
||||
**Version**: 1.0
|
||||
|
||||
## 🧭 **Navigation Path:**
|
||||
**🏠 [Documentation Home](../README.md)** → **🛠️ Development** → *You are here*
|
||||
|
||||
**breadcrumb**: Home → Development → Overview
|
||||
|
||||
---
|
||||
|
||||
## 🎯 **See Also:**
|
||||
- **📋 [Project Documentation](../project/README.md)** - Project structure and workflow context
|
||||
- **🏗️ [Infrastructure Documentation](../infrastructure/README.md)** - Operational environment details
|
||||
- **🧪 [Testing Documentation](../testing/)** - Test-oriented workflow resources
|
||||
- **📚 [Master Index](../MASTER_INDEX.md)** - Full documentation catalog
|
||||
|
||||
---
|
||||
|
||||
## 📦 **Contents**
|
||||
|
||||
- **[DEBUgging_SERVICES.md](DEBUgging_SERVICES.md)** - Service debugging notes and troubleshooting steps
|
||||
- **[DEV_LOGS.md](DEV_LOGS.md)** - Development log tracking
|
||||
- **[DEV_LOGS_QUICK_REFERENCE.md](DEV_LOGS_QUICK_REFERENCE.md)** - Fast reference for common dev logs
|
||||
- **[mock-data-system.md](mock-data-system.md)** - Mock data system notes and workflow
|
||||
|
||||
---
|
||||
|
||||
## 🧱 **Purpose**
|
||||
|
||||
This directory collects operational development notes that help contributors:
|
||||
|
||||
- debug services and runtime behavior
|
||||
- inspect and interpret logs quickly
|
||||
- understand mock or fixture data flows
|
||||
- keep development workflows repeatable
|
||||
|
||||
---
|
||||
|
||||
## 🚀 **Next Steps**
|
||||
|
||||
- Use `DEV_LOGS_QUICK_REFERENCE.md` for the fastest log lookup path.
|
||||
- Review `DEBUgging_SERVICES.md` when diagnosing service issues.
|
||||
- Keep development notes aligned with `../about/DOCUMENTATION_TEMPLATE_STANDARD.md`.
|
||||
|
||||
---
|
||||
|
||||
*Last updated: 2026-04-27*
|
||||
*Version: 1.0*
|
||||
*Status: Development entry point*
|
||||
Reference in New Issue
Block a user