Skip to content

Commit 92abd38

Browse files
Roo Coderuvnet
andcommitted
Align docs to codebase: delete 28 phantom/duplicate files, update diagrams
Deleted 14 phantom feature docs: - Protein folding, digital twin, multiplayer game tutorials (not implemented) - DID/Nostr integration PRD and AFD (aspirational only) - Vircadia multi-user and XR guides (not operational) - DeepSeek deployment docs (no deployment code) - Fashion content enrichment plan (domain-specific, not in codebase) - Finance, gaming, healthcare, manufacturing case studies (aspirational) Deleted 14 duplicate/wrong docs: - architecture.md (described Vircadia/PostgreSQL, actual is Actix/Neo4j) - 5 duplicate API reference files (kept api/API_REFERENCE.md) - 3 duplicate binary protocol docs (kept binary-protocol-complete.md) - 2 duplicate contributing guides (kept top-level CONTRIBUTING.md) - 2 duplicate stress majorisation docs - 1 wrong REST API doc (described Management API, not VisionFlow) Updated 5 key docs: - ARCHITECTURE.md: actor hierarchy expanded from 8 to 30 actors, CUDA 13.1, 110 kernels - actor-system-complete.md: full 30-actor tree with 4 subsystem groups - complete-data-flows.md: sections 4/5/7 updated for V3 protocol (48 bytes/node), autoSaveManager settings path, GPU propagation - actor-system.md: actor count 21+ -> 30 - README.md hub: fixed 10 broken links, updated stats, auth description Net: -14,509 lines of stale documentation removed. Co-Authored-By: claude-flow <ruv@ruv.net>
1 parent 53043bb commit 92abd38

33 files changed

Lines changed: 198 additions & 14707 deletions

docs/README.md

Lines changed: 19 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -60,11 +60,11 @@ Get running in 5 minutes:
6060
- **React Frontend** - [Client Architecture](explanation/architecture/client/overview.md), [State Management](how-to/development/state-management.md)
6161
- **Neo4j** - [Database Architecture](explanation/architecture/database.md), [Schemas](reference/database/schemas.md)
6262
- **GPU/CUDA** - [GPU Overview](explanation/architecture/gpu/README.md), [Optimisations](explanation/architecture/gpu/optimizations.md)
63-
- **WebSocket** - [Binary Protocol](reference/protocols/binary-websocket.md), [Best Practices](how-to/development/websocket-best-practices.md)
63+
- **WebSocket** - [Binary Protocol](diagrams/infrastructure/websocket/binary-protocol-complete.md), [Best Practices](how-to/development/websocket-best-practices.md)
6464

6565
### API Reference
6666

67-
- [REST API](reference/api/rest-api-complete.md)
67+
- [REST API](api/API_REFERENCE.md)
6868
- [WebSocket API](reference/api/03-websocket.md)
6969
- [Authentication](reference/api/01-authentication.md)
7070

@@ -191,14 +191,14 @@ graph TB
191191
| **Deploy AI agents** | [Agent Orchestration](how-to/agents/agent-orchestration.md) |
192192
| **Query Neo4j** | [Neo4j Integration](how-to/integration/neo4j-integration.md) |
193193
| **Add a feature** | [Adding Features](how-to/development/04-adding-features.md) |
194-
| **Set up XR/VR** | [Vircadia XR Guide](how-to/features/vircadia-xr-complete-guide.md) |
194+
| **Set up XR/VR** | [XR Architecture](diagrams/client/xr/xr-architecture-complete.md) |
195195
| **Understand architecture** | [Architecture Overview](explanation/architecture/README.md) |
196196
| **Learn the codebase** | [Developer Journey](explanation/architecture/developer-journey.md) |
197197
| **Deploy to production** | [Deployment Guide](how-to/deployment/deployment.md) |
198198
| **Configure environment** | [Configuration](how-to/operations/configuration.md) |
199199
| **Fix issues** | [Troubleshooting](how-to/operations/troubleshooting.md) |
200200
| **Write tests** | [Testing Guide](how-to/development/testing-guide.md) |
201-
| **Use REST API** | [REST API](reference/api/rest-api-complete.md) |
201+
| **Use REST API** | [REST API](api/API_REFERENCE.md) |
202202
| **Use WebSocket API** | [WebSocket API](reference/api/03-websocket.md) |
203203
| **Optimise performance** | [GPU Optimisations](explanation/architecture/gpu/optimizations.md) |
204204
| **Secure the app** | [Security Guide](how-to/operations/security.md) |
@@ -213,7 +213,6 @@ Step-by-step lessons for beginners.
213213
|----------|------|-------------|
214214
| [Installation](tutorials/installation.md) | 10 min | Docker and native setup |
215215
| [First Graph](tutorials/creating-first-graph.md) | 15 min | Create your first visualisation |
216-
| [Neo4j Quick Start](tutorials/neo4j-basics.md) | 20 min | Query the graph database |
217216

218217
### Concepts (Understanding-Oriented)
219218

@@ -262,7 +261,7 @@ Practical instructions for specific goals.
262261
- [Development Setup](how-to/development/01-development-setup.md) - Environment
263262
- [Project Structure](how-to/development/02-project-structure.md) - Code organisation
264263
- [Adding Features](how-to/development/04-adding-features.md) - Workflow
265-
- [Contributing](how-to/development/06-contributing.md) - Code standards
264+
- [Contributing](CONTRIBUTING.md) - Code standards
266265
- [WebSocket Best Practices](how-to/development/websocket-best-practices.md) - Real-time
267266
- [JSON Serialisation](how-to/development/json-serialization-patterns.md) - Data formats
268267
- [Test Execution](how-to/development/test-execution.md) - Running tests
@@ -279,7 +278,7 @@ Practical instructions for specific goals.
279278
- [Telemetry](how-to/operations/telemetry-logging.md) - Observability
280279
- [Operator Runbook](how-to/operations/pipeline-operator-runbook.md) - Operations
281280
- [Infrastructure Architecture](how-to/infrastructure/architecture.md) - System design
282-
- [Docker Environment](how-to/infrastructure/docker-environment.md) - Containers
281+
- [Docker Environment](how-to/deployment/docker-environment.md) - Containers
283282
- [Port Configuration](how-to/infrastructure/port-configuration.md) - Networking
284283
- [Infrastructure Troubleshooting](how-to/infrastructure/troubleshooting.md) - Issues
285284

@@ -309,7 +308,7 @@ Deep dives into architecture and design.
309308
- [GPU Semantic Forces](explanation/architecture/gpu-semantic-forces.md) - CUDA kernels
310309
- [GPU Communication](explanation/architecture/gpu/communication-flow.md) - Data transfer
311310
- [GPU Optimisations](explanation/architecture/gpu/optimizations.md) - Performance
312-
- [Stress Majorisation](explanation/architecture/stress-majorization.md) - Layout algorithm
311+
- [Stress Majorisation](how-to/features/stress-majorization-guide.md) - Layout algorithm
313312

314313
</details>
315314

@@ -331,10 +330,9 @@ Technical specifications and APIs.
331330
<details>
332331
<summary>API Documentation (8 references)</summary>
333332

334-
- [API Complete](reference/api-complete-reference.md) - All endpoints
335-
- [REST API](reference/api/rest-api-complete.md) - HTTP API spec
333+
- [API Reference](api/API_REFERENCE.md) - All endpoints (Actix-web, port 8080)
336334
- [WebSocket API](reference/api/03-websocket.md) - Real-time protocol
337-
- [Authentication](reference/api/01-authentication.md) - JWT and Nostr
335+
- [Authentication](reference/api/01-authentication.md) - Nostr NIP-07/NIP-98
338336
- [Semantic Features API](reference/api/semantic-features-api.md) - NL queries
339337

340338
</details>
@@ -345,8 +343,8 @@ Technical specifications and APIs.
345343
- [Database Schemas](reference/database/schemas.md) - Neo4j schema
346344
- [Ontology Schema V2](reference/database/ontology-schema-v2.md) - OWL schema
347345
- [User Settings Schema](reference/database/user-settings-schema.md) - User data
348-
- [Binary WebSocket](reference/protocols/binary-websocket.md) - 36-byte format
349-
- [WebSocket Protocol](reference/websocket-protocol.md) - V2 spec
346+
- [Binary Protocol](diagrams/infrastructure/websocket/binary-protocol-complete.md) - V3 (48 bytes/node) and V4 delta encoding
347+
- [Protocol Matrix](reference/protocols/protocol-matrix.md) - Protocol version comparison
350348

351349
</details>
352350

@@ -375,16 +373,16 @@ Technical specifications and APIs.
375373

376374
| Category | Count |
377375
|----------|-------|
378-
| **Tutorials** | 5 |
379-
| **How-To Guides** | 81 |
380-
| **Explanation** | 72 |
381-
| **Reference** | 46 |
382-
| **Other (diagrams, research)** | 38 |
383-
| **Total** | 242 markdown files |
376+
| **Tutorials** | 2 |
377+
| **How-To Guides** | 68 |
378+
| **Explanation** | 70 |
379+
| **Reference** | 39 |
380+
| **Other (diagrams, research)** | 35 |
381+
| **Total** | ~214 markdown files |
384382

385383
- **Framework**: Diataxis (Tutorials, How-To, Explanation, Reference)
386-
- **Last Updated**: 2026-02-11
387-
- **Verified**: Links checked, Mermaid diagrams validated
384+
- **Last Updated**: 2026-03-24
385+
- **Audit**: [DOCS-AUDIT-2026-03-24.md](DOCS-AUDIT-2026-03-24.md)
388386

389387
---
390388

docs/afd-did-nostr-identity.md

Lines changed: 0 additions & 114 deletions
This file was deleted.

0 commit comments

Comments
 (0)