Skip to content

Commit d01bc5b

Browse files
mrveissclaude
mrveiss
and
claude
committed
docs(nav): add _index.md navigation hubs for all docs directories
Add 23 Obsidian-compatible directory index files so every major docs section is reachable from the vault graph view and file explorer. Each _index.md lists the documents in its directory with descriptions, uses frontmatter tags/aliases, and passes markdown linting. Directories covered: adr, agents, api, architecture, archives/plans, deployment, developer, development, features, frontend, guides, implementation, infrastructure, operations, planning, refactoring, runbooks, sdk, security, testing, troubleshooting, user, workflow. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 0d0993b commit d01bc5b

23 files changed

Lines changed: 995 additions & 0 deletions

File tree

‎docs/adr/_index.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
tags:
3+
- index
4+
- adr
5+
aliases:
6+
- ADR Index
7+
---
8+
9+
# Architecture Decision Records
10+
11+
| Document | Description |
12+
| --- | --- |
13+
| [README](README.md) | ADR overview |
14+
| [template](template.md) | ADR template |
15+
| [decisions](decisions.md) | All decisions log |
16+
| [001-distributed-vm-architecture](001-distributed-vm-architecture.md) | Distributed VM architecture |
17+
| [002-redis-database-separation](002-redis-database-separation.md) | Redis database separation |
18+
| [003-npu-integration-strategy](003-npu-integration-strategy.md) | NPU integration strategy |
19+
| [004-chat-workflow-architecture](004-chat-workflow-architecture.md) | Chat workflow architecture |
20+
| [005-single-frontend-mandate](005-single-frontend-mandate.md) | Single frontend mandate |

‎docs/agents/_index.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
tags:
3+
- index
4+
- agents
5+
aliases:
6+
- Agents Index
7+
---
8+
9+
# Agent Documentation
10+
11+
| Document | Description |
12+
| --- | --- |
13+
| [README](README.md) | Agents overview |
14+
| [helper-agents-guide](helper-agents-guide.md) | Helper agents guide |
15+
| [librarian-agents-guide](librarian-agents-guide.md) | Librarian agents guide |
16+
| [multi-agent-architecture](multi-agent-architecture.md) | Multi-agent architecture |
17+
| [mcp-tools-reference](mcp-tools-reference.md) | MCP tools reference |
18+
| [STANDARDIZED_AGENT_MIGRATION](STANDARDIZED_AGENT_MIGRATION.md) | Agent migration guide |
19+
| [development/npu_code_search_agent](development/npu_code_search_agent.md) | NPU code search agent |
20+
| [knowledge/kb_librarian_agent](knowledge/kb_librarian_agent.md) | KB librarian agent |
21+
| [orchestration/agent_orchestrator](orchestration/agent_orchestrator.md) | Agent orchestrator |

‎docs/api/_index.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
tags:
3+
- index
4+
- api
5+
aliases:
6+
- API Index
7+
---
8+
9+
# API Documentation
10+
11+
## Reference
12+
13+
| Document | Description |
14+
| --- | --- |
15+
| [COMPREHENSIVE_API_DOCUMENTATION](COMPREHENSIVE_API_DOCUMENTATION.md) | Full API reference |
16+
| [API_ENDPOINT_MAPPING](API_ENDPOINT_MAPPING.md) | Endpoint overview |
17+
| [public-api-reference](public-api-reference.md) | Public API reference |
18+
| [api-versioning](api-versioning.md) | API versioning guide |
19+
| [environment-variables](environment-variables.md) | Environment variables |
20+
21+
## Specific APIs
22+
23+
| Document | Description |
24+
| --- | --- |
25+
| [WEBSOCKET_INTEGRATION_GUIDE](WEBSOCKET_INTEGRATION_GUIDE.md) | WebSocket integration |
26+
| [Terminal_API_Consolidated](Terminal_API_Consolidated.md) | Terminal API |
27+
| [AGENT_TERMINAL_API](AGENT_TERMINAL_API.md) | Agent terminal API |
28+
| [REDIS_SERVICE_MANAGEMENT_API](REDIS_SERVICE_MANAGEMENT_API.md) | Redis service management API |
29+
| [redis-documentation](redis-documentation.md) | Redis documentation |
30+
| [npu-worker-pool](npu-worker-pool.md) | NPU worker pool API |
31+
| [IP_ADDRESSING_SCHEME](IP_ADDRESSING_SCHEME.md) | IP addressing scheme |
32+
| [FRONTEND_INTEGRATION_API_SPECS](FRONTEND_INTEGRATION_API_SPECS.md) | Frontend integration specs |
33+
| [CODE_VECTORIZATION_API](CODE_VECTORIZATION_API.md) | Code vectorization API |
34+
35+
## Analysis & Cleanup
36+
37+
| Document | Description |
38+
| --- | --- |
39+
| [API_Consolidation_Priority_Plan](API_Consolidation_Priority_Plan.md) | Consolidation plan |
40+
| [API_Duplication_Analysis](API_Duplication_Analysis.md) | Duplication analysis |
41+
| [API_Endpoint_Cleanup_Plan](API_Endpoint_Cleanup_Plan.md) | Endpoint cleanup plan |
42+
| [Browser_API_Async_Improvements](Browser_API_Async_Improvements.md) | Browser API async improvements |

‎docs/architecture/_index.md‎

Lines changed: 120 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,120 @@
1+
---
2+
tags:
3+
- index
4+
- architecture
5+
aliases:
6+
- Architecture Index
7+
---
8+
9+
# Architecture Documentation
10+
11+
## Overview
12+
13+
| Document | Description |
14+
| --- | --- |
15+
| [README](README.md) | Architecture overview |
16+
| [INDEX](INDEX.md) | Architecture index |
17+
| [VISUAL_ARCHITECTURE](VISUAL_ARCHITECTURE.md) | Visual architecture diagram |
18+
| [DISTRIBUTED_6VM_ARCHITECTURE](DISTRIBUTED_6VM_ARCHITECTURE.md) | 6-VM distributed deployment |
19+
| [DISTRIBUTED_ARCHITECTURE](DISTRIBUTED_ARCHITECTURE.md) | Distributed architecture |
20+
| [NETWORK_TOPOLOGY](NETWORK_TOPOLOGY.md) | Network topology |
21+
| [data-flows](data-flows.md) | Data flow diagrams |
22+
| [dependency_injection](dependency_injection.md) | Dependency injection patterns |
23+
24+
## Agent System
25+
26+
| Document | Description |
27+
| --- | --- |
28+
| [AGENT_SYSTEM_ARCHITECTURE](AGENT_SYSTEM_ARCHITECTURE.md) | Agent system design |
29+
| [Agent_Communication_Protocol](Agent_Communication_Protocol.md) | Agent communication protocol |
30+
| [INDUSTRY_AGENT_PATTERNS_ANALYSIS](INDUSTRY_AGENT_PATTERNS_ANALYSIS.md) | Industry agent patterns |
31+
| [COEXISTENCE_MATRIX](COEXISTENCE_MATRIX.md) | Agent coexistence matrix |
32+
33+
## API & Communication
34+
35+
| Document | Description |
36+
| --- | --- |
37+
| [COMMUNICATION_ARCHITECTURE](COMMUNICATION_ARCHITECTURE.md) | Communication architecture |
38+
| [API_VS_DIRECT_QUICK_REFERENCE](API_VS_DIRECT_QUICK_REFERENCE.md) | API vs direct access |
39+
| [CHAT_INFRASTRUCTURE_ACCESS_DESIGN](CHAT_INFRASTRUCTURE_ACCESS_DESIGN.md) | Chat infrastructure design |
40+
| [LONG_RUNNING_OPERATIONS_ARCHITECTURE](LONG_RUNNING_OPERATIONS_ARCHITECTURE.md) | Long-running operations |
41+
42+
## Configuration & SSOT
43+
44+
| Document | Description |
45+
| --- | --- |
46+
| [SSOT_CONFIGURATION_ARCHITECTURE](SSOT_CONFIGURATION_ARCHITECTURE.md) | SSOT config architecture |
47+
| [CONFIG_CONSOLIDATION_ANALYSIS](CONFIG_CONSOLIDATION_ANALYSIS.md) | Config consolidation analysis |
48+
| [CONFIG_MIGRATION_IMPLEMENTATION](CONFIG_MIGRATION_IMPLEMENTATION.md) | Config migration implementation |
49+
50+
## Memory & Knowledge
51+
52+
| Document | Description |
53+
| --- | --- |
54+
| [AUTOBOT_MEMORY_GRAPH_ARCHITECTURE](AUTOBOT_MEMORY_GRAPH_ARCHITECTURE.md) | Memory graph architecture |
55+
| [MEMORY_GRAPH_CHAT_INTEGRATION](MEMORY_GRAPH_CHAT_INTEGRATION.md) | Memory graph + chat |
56+
| [VECTOR_STORE_MIGRATION](VECTOR_STORE_MIGRATION.md) | Vector store migration |
57+
| [BACKGROUND_VECTORIZATION](BACKGROUND_VECTORIZATION.md) | Background vectorization |
58+
| [EFFICIENT_INFERENCE_DESIGN](EFFICIENT_INFERENCE_DESIGN.md) | Efficient inference |
59+
60+
## Code Vectorization
61+
62+
| Document | Description |
63+
| --- | --- |
64+
| [CODE_VECTORIZATION_ARCHITECTURE](CODE_VECTORIZATION_ARCHITECTURE.md) | Code vectorization architecture |
65+
| [CODE_VECTORIZATION_README](CODE_VECTORIZATION_README.md) | Code vectorization overview |
66+
| [CODE_VECTORIZATION_DATA_FLOWS](CODE_VECTORIZATION_DATA_FLOWS.md) | Data flows |
67+
| [CODE_VECTORIZATION_IMPLEMENTATION_PLAN](CODE_VECTORIZATION_IMPLEMENTATION_PLAN.md) | Implementation plan |
68+
| [CODE_VECTORIZATION_PERFORMANCE_RISK](CODE_VECTORIZATION_PERFORMANCE_RISK.md) | Performance & risk |
69+
| [CODE_VECTORIZATION_SUMMARY](CODE_VECTORIZATION_SUMMARY.md) | Summary |
70+
71+
## Terminal
72+
73+
| Document | Description |
74+
| --- | --- |
75+
| [TERMINAL_ARCHITECTURE_DIAGRAM](TERMINAL_ARCHITECTURE_DIAGRAM.md) | Terminal architecture diagram |
76+
| [TERMINAL_ARCHITECTURE_DISTRIBUTED](TERMINAL_ARCHITECTURE_DISTRIBUTED.md) | Distributed terminal architecture |
77+
| [TERMINAL_APPROVAL_WORKFLOW](TERMINAL_APPROVAL_WORKFLOW.md) | Terminal approval workflow |
78+
| [TERMINAL_CONSOLIDATION_ANALYSIS](TERMINAL_CONSOLIDATION_ANALYSIS.md) | Consolidation analysis |
79+
| [TERMINAL_INTEGRATION_ARCHITECTURE_VALIDATION](TERMINAL_INTEGRATION_ARCHITECTURE_VALIDATION.md) | Integration validation |
80+
81+
## Monitoring & Security
82+
83+
| Document | Description |
84+
| --- | --- |
85+
| [MONITORING_ARCHITECTURE](MONITORING_ARCHITECTURE.md) | Monitoring architecture |
86+
| [Advanced_Monitoring_System](Advanced_Monitoring_System.md) | Advanced monitoring |
87+
| [SECURITY_ASSESSMENT_WORKFLOW](SECURITY_ASSESSMENT_WORKFLOW.md) | Security assessment workflow |
88+
| [PHASE_VALIDATION_SYSTEM](PHASE_VALIDATION_SYSTEM.md) | Phase validation |
89+
| [BACKEND_CRITICAL_ISSUES_ARCHITECTURAL_ANALYSIS](BACKEND_CRITICAL_ISSUES_ARCHITECTURAL_ANALYSIS.md) | Critical issues analysis |
90+
91+
## Frontend & Roles
92+
93+
| Document | Description |
94+
| --- | --- |
95+
| [FRONTEND_ARCHITECTURE_ASSESSMENT](FRONTEND_ARCHITECTURE_ASSESSMENT.md) | Frontend architecture |
96+
| [ROLE_ARCHITECTURE](ROLE_ARCHITECTURE.md) | Role architecture |
97+
98+
## Scaling & Migration
99+
100+
| Document | Description |
101+
| --- | --- |
102+
| [Scaling_Roadmap_and_Architecture_Evolution](Scaling_Roadmap_and_Architecture_Evolution.md) | Scaling roadmap |
103+
| [Kubernetes_Migration_Strategy](Kubernetes_Migration_Strategy.md) | Kubernetes migration |
104+
| [Async_System_Migration](Async_System_Migration.md) | Async migration |
105+
| [Docker_Architecture_Documentation](Docker_Architecture_Documentation.md) | Docker architecture |
106+
| [Docker_Architecture_Quick_Start](Docker_Architecture_Quick_Start.md) | Docker quick start |
107+
| [UPDATE_FLOWS](UPDATE_FLOWS.md) | Update flows |
108+
| [redis-schema](redis-schema.md) | Redis schema |
109+
| [KB-ASYNC-014-COMPLETION-SUMMARY](KB-ASYNC-014-COMPLETION-SUMMARY.md) | KB async completion |
110+
| [Performance_and_Security_Optimizations](Performance_and_Security_Optimizations.md) | Performance & security |
111+
112+
## Design Records
113+
114+
| Document | Description |
115+
| --- | --- |
116+
| [designs/ARCHITECTURE_DECISION_RECORD](designs/ARCHITECTURE_DECISION_RECORD.md) | Architecture decision record |
117+
| [designs/EVENT_STREAM_SYSTEM_DESIGN](designs/EVENT_STREAM_SYSTEM_DESIGN.md) | Event stream design |
118+
| [designs/KNOWLEDGE_MODULE_ENHANCEMENTS_DESIGN](designs/KNOWLEDGE_MODULE_ENHANCEMENTS_DESIGN.md) | Knowledge module enhancements |
119+
| [designs/PARALLEL_TOOL_EXECUTION_DESIGN](designs/PARALLEL_TOOL_EXECUTION_DESIGN.md) | Parallel tool execution |
120+
| [designs/PLANNER_MODULE_DESIGN](designs/PLANNER_MODULE_DESIGN.md) | Planner module design |

0 commit comments

Comments
 (0)