@rbalchii/anchor-engine 4.7.0 → 4.8.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +608 -608
- package/README.md +513 -317
- package/anchor.bat +5 -5
- package/docs/AGENT_CONTROLLED_ENGINE.md +581 -0
- package/docs/API.md +314 -314
- package/docs/DEPLOYMENT.md +448 -448
- package/docs/INDEX.md +226 -226
- package/docs/MD_FILES_INVENTORY.md +166 -0
- package/docs/STAR_Whitepaper_Executive.md +216 -216
- package/docs/TROUBLESHOOTING.md +535 -535
- package/docs/arxiv/BIBLIOGRAPHY.bib +145 -145
- package/docs/arxiv/RELATED_WORK.tex +38 -38
- package/docs/arxiv/compile.bat +48 -48
- package/docs/arxiv/joss_response.md +32 -32
- package/docs/arxiv/prepare-submission.bat +46 -46
- package/docs/arxiv/review.md +127 -127
- package/docs/arxiv/star-whitepaper.tex +656 -656
- package/docs/code-patterns.md +289 -289
- package/docs/daily/TODAY_SUMMARY.md +245 -0
- package/docs/guides/BUILDING.md +64 -0
- package/docs/guides/INSTALL_NPM.md +160 -0
- package/docs/guides/NPM_PUBLISH_SUMMARY.md +231 -0
- package/docs/paper.md +124 -0
- package/docs/project/PROJECT_STATE_ASSESSMENT.md +312 -0
- package/docs/reviews/code-review-v4.8.1-decision-record.md +165 -0
- package/docs/testing/TESTING.md +213 -0
- package/docs/testing/TESTING_FRAMEWORK_COMPLETE.md +271 -0
- package/docs/testing/search-test-report.md +76 -0
- package/docs/whitepaper.md +445 -445
- package/engine/dist/commands/distill.js +21 -21
- package/engine/dist/config/index.d.ts +7 -0
- package/engine/dist/config/index.d.ts.map +1 -1
- package/engine/dist/config/index.js +22 -0
- package/engine/dist/config/index.js.map +1 -1
- package/engine/dist/config/paths.d.ts +1 -1
- package/engine/dist/config/paths.js +3 -3
- package/engine/dist/config/paths.js.map +1 -1
- package/engine/dist/core/db.js +131 -131
- package/engine/dist/mcp/server.d.ts +44 -0
- package/engine/dist/mcp/server.d.ts.map +1 -0
- package/engine/dist/mcp/server.js +427 -0
- package/engine/dist/mcp/server.js.map +1 -0
- package/engine/dist/native/index.d.ts +20 -21
- package/engine/dist/native/index.d.ts.map +1 -1
- package/engine/dist/profiling/atomization-profiling.js +3 -3
- package/engine/dist/profiling/bottleneck-identification.js +35 -35
- package/engine/dist/profiling/content-sanitization-profiling.js +86 -86
- package/engine/dist/routes/monitoring.js +8 -8
- package/engine/dist/routes/v1/admin.js +8 -8
- package/engine/dist/routes/v1/atoms.js +15 -15
- package/engine/dist/routes/v1/ingest.d.ts.map +1 -1
- package/engine/dist/routes/v1/ingest.js +39 -0
- package/engine/dist/routes/v1/ingest.js.map +1 -1
- package/engine/dist/routes/v1/system.d.ts.map +1 -1
- package/engine/dist/routes/v1/system.js +305 -6
- package/engine/dist/routes/v1/system.js.map +1 -1
- package/engine/dist/routes/v1/tags.js +2 -2
- package/engine/dist/services/backup/backup-restore.js +23 -23
- package/engine/dist/services/backup/backup.js +14 -14
- package/engine/dist/services/distillation/radial-distiller.d.ts +1 -0
- package/engine/dist/services/distillation/radial-distiller.d.ts.map +1 -1
- package/engine/dist/services/distillation/radial-distiller.js +23 -16
- package/engine/dist/services/distillation/radial-distiller.js.map +1 -1
- package/engine/dist/services/ingest/github-ingest-service.js +18 -18
- package/engine/dist/services/ingest/ingest-atomic.js +79 -79
- package/engine/dist/services/ingest/ingest.d.ts.map +1 -1
- package/engine/dist/services/ingest/ingest.js +28 -25
- package/engine/dist/services/ingest/ingest.js.map +1 -1
- package/engine/dist/services/ingest/watchdog.d.ts.map +1 -1
- package/engine/dist/services/ingest/watchdog.js +14 -24
- package/engine/dist/services/ingest/watchdog.js.map +1 -1
- package/engine/dist/services/llm/reader.js +9 -9
- package/engine/dist/services/mirror/mirror.js +5 -5
- package/engine/dist/services/mirror/mirror.js.map +1 -1
- package/engine/dist/services/research/researcher.js +8 -8
- package/engine/dist/services/scribe/scribe.js +27 -27
- package/engine/dist/services/search/context-inflator.js +34 -34
- package/engine/dist/services/search/explore.js +20 -20
- package/engine/dist/services/search/physics-tag-walker.js +208 -208
- package/engine/dist/services/search/query-parser.js +5 -5
- package/engine/dist/services/search/search-utils.js +3 -3
- package/engine/dist/services/search/search.js +36 -36
- package/engine/dist/services/search/sovereign-system-prompt.js +22 -22
- package/engine/dist/services/semantic/semantic-ingestion-service.js +47 -47
- package/engine/dist/services/semantic/semantic-search.js +21 -21
- package/engine/dist/services/synonyms/auto-synonym-generator.js +35 -35
- package/engine/dist/services/system-status.d.ts +34 -0
- package/engine/dist/services/system-status.d.ts.map +1 -1
- package/engine/dist/services/system-status.js +57 -1
- package/engine/dist/services/system-status.js.map +1 -1
- package/engine/dist/services/tags/discovery.js +5 -5
- package/engine/dist/services/tags/infector.js +6 -6
- package/engine/dist/services/tags/tag-auditor.js +51 -51
- package/engine/dist/services/taxonomy/taxonomy-manager.js +6 -6
- package/engine/dist/utils/tag-cleanup.js +5 -5
- package/engine/dist/utils/tag-modulation.js +1 -1
- package/engine/dist/utils/tag-modulation.js.map +1 -1
- package/engine/package.json +104 -105
- package/mcp-server/README.md +404 -0
- package/mcp-server/dist/index.d.ts +16 -0
- package/mcp-server/dist/index.d.ts.map +1 -0
- package/mcp-server/dist/index.js +709 -0
- package/mcp-server/dist/index.js.map +1 -0
- package/mcp-server/package.json +34 -0
- package/package.json +10 -2
- package/docs/archive/GIT_BACKUP_VERIFICATION.md +0 -297
- package/docs/archive/adoption-guide.md +0 -264
- package/docs/archive/adoption-preparation.md +0 -179
- package/docs/archive/agent-harness-integration.md +0 -227
- package/docs/archive/api-reference.md +0 -106
- package/docs/archive/api_flows_diagram.md +0 -118
- package/docs/archive/architecture.md +0 -410
- package/docs/archive/architecture_diagram.md +0 -174
- package/docs/archive/broader-adoption-preparation.md +0 -175
- package/docs/archive/browser-paradigm-architecture.md +0 -163
- package/docs/archive/chat-integration.md +0 -124
- package/docs/archive/community-adoption-materials.md +0 -103
- package/docs/archive/community-adoption.md +0 -147
- package/docs/archive/comparison-with-siloed-solutions.md +0 -192
- package/docs/archive/comprehensive-docs.md +0 -156
- package/docs/archive/data_flow_diagram.md +0 -251
- package/docs/archive/enhancement-implementation-summary.md +0 -146
- package/docs/archive/evolution-summary.md +0 -141
- package/docs/archive/ingestion_pipeline_diagram.md +0 -198
- package/docs/archive/native-module-profiling-results.md +0 -135
- package/docs/archive/positioning-document.md +0 -158
- package/docs/archive/positioning.md +0 -175
- package/docs/archive/query-builder-documentation.md +0 -218
- package/docs/archive/quick-reference.md +0 -40
- package/docs/archive/quickstart.md +0 -63
- package/docs/archive/relationship-narrative-discovery.md +0 -141
- package/docs/archive/search-logic-improvement-plan.md +0 -336
- package/docs/archive/search_architecture_diagram.md +0 -212
- package/docs/archive/semantic-architecture-guide.md +0 -97
- package/docs/archive/sequence-diagrams.md +0 -128
- package/docs/archive/system_components_diagram.md +0 -296
- package/docs/archive/test-framework-integration.md +0 -109
- package/docs/archive/testing-framework-documentation.md +0 -397
- package/docs/archive/testing-framework-summary.md +0 -121
- package/docs/archive/testing-framework.md +0 -377
- package/docs/archive/ui-architecture.md +0 -75
package/docs/INDEX.md
CHANGED
|
@@ -1,226 +1,226 @@
|
|
|
1
|
-
# Anchor Engine - Documentation Index
|
|
2
|
-
|
|
3
|
-
**Version:** 4.8.0 | **Updated:** March 18, 2026 | **Status:** ✅ Production Ready
|
|
4
|
-
|
|
5
|
-
---
|
|
6
|
-
|
|
7
|
-
## 📚 Quick Navigation
|
|
8
|
-
|
|
9
|
-
### Getting Started
|
|
10
|
-
- **[README.md](../README.md)** - Quick start, installation, usage guide
|
|
11
|
-
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history (latest: v4.8.0)
|
|
12
|
-
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute
|
|
13
|
-
|
|
14
|
-
### Core Documentation
|
|
15
|
-
- **[docs/API.md](API.md)** - Complete API reference
|
|
16
|
-
- **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - Deployment guide (local, Docker, VPS, K8s)
|
|
17
|
-
- **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Troubleshooting guide
|
|
18
|
-
- **[docs/whitepaper.md](whitepaper.md)** - STAR Algorithm whitepaper
|
|
19
|
-
- **[specs/spec.md](../specs/spec.md)** - System specification with architecture diagrams
|
|
20
|
-
- **[specs/current-standards/](../specs/current-standards/)** - Active architecture standards (001-010)
|
|
21
|
-
|
|
22
|
-
### Development
|
|
23
|
-
- **[engine/src/README.md](../engine/src/README.md)** - Source code overview
|
|
24
|
-
- **[tests/README.md](../tests/README.md)** - Testing guide
|
|
25
|
-
- **[benchmarks/README.md](../benchmarks/README.md)** - Benchmarking framework
|
|
26
|
-
- **[mcp-server/README.md](../mcp-server/README.md)** - MCP server integration
|
|
27
|
-
|
|
28
|
-
---
|
|
29
|
-
|
|
30
|
-
## 🎯 Documentation by Use Case
|
|
31
|
-
|
|
32
|
-
### "I want to install and run Anchor Engine"
|
|
33
|
-
→ Start with **[README.md](../README.md)** - Quick Start section
|
|
34
|
-
|
|
35
|
-
### "I need API documentation"
|
|
36
|
-
→ Read **[docs/API.md](API.md)** - Complete API reference with examples
|
|
37
|
-
|
|
38
|
-
### "I want to deploy to production"
|
|
39
|
-
→ Follow **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - All deployment options
|
|
40
|
-
|
|
41
|
-
### "Something's not working"
|
|
42
|
-
→ Check **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and fixes
|
|
43
|
-
|
|
44
|
-
### "I need to understand the system architecture"
|
|
45
|
-
→ Study **[specs/spec.md](../specs/spec.md)** - System specification with diagrams
|
|
46
|
-
|
|
47
|
-
### "I'm researching the theory behind Anchor Engine"
|
|
48
|
-
→ Read **[docs/whitepaper.md](whitepaper.md)** - Academic paper
|
|
49
|
-
|
|
50
|
-
### "I want to understand the search algorithm"
|
|
51
|
-
→ See **[specs/current-standards/004-streaming-search.md](../specs/current-standards/004-streaming-search.md)**
|
|
52
|
-
|
|
53
|
-
### "How does distillation work?"
|
|
54
|
-
→ Read **[specs/current-standards/010-radial-distillation-v2.md](../specs/current-standards/010-radial-distillation-v2.md)**
|
|
55
|
-
|
|
56
|
-
### "I want to contribute code"
|
|
57
|
-
→ Start with **[engine/src/README.md](../engine/src/README.md)** - Source overview
|
|
58
|
-
|
|
59
|
-
### "I need to write tests"
|
|
60
|
-
→ Follow **[tests/README.md](../tests/README.md)** - Testing guide
|
|
61
|
-
|
|
62
|
-
### "I want to connect via MCP"
|
|
63
|
-
→ See **[mcp-server/README.md](../mcp-server/README.md)** - MCP integration
|
|
64
|
-
|
|
65
|
-
---
|
|
66
|
-
|
|
67
|
-
## 📊 Key Metrics (v4.8.0)
|
|
68
|
-
|
|
69
|
-
| Metric | Value | Status |
|
|
70
|
-
|--------|-------|--------|
|
|
71
|
-
| **Context Retrieval** | 618k chars | ✅ +18% vs whitepaper |
|
|
72
|
-
| **Memory Peak** | 510MB | ✅ -70% vs whitepaper |
|
|
73
|
-
| **Search Latency** | <200ms (p95) | ✅ Optimized |
|
|
74
|
-
| **Ingestion Throughput** | 1,200 mol/sec | ✅ Verified |
|
|
75
|
-
| **Deduplication Rate** | 40-50% | ✅ With SimHash |
|
|
76
|
-
| **Session Index** | NEW in v4.8.0 | ✅ Two-tier retrieval |
|
|
77
|
-
| **MCP Write Ops** | NEW in v4.8.0 | ✅ Opt-in ingest |
|
|
78
|
-
|
|
79
|
-
---
|
|
80
|
-
|
|
81
|
-
## 🗂️ Document Structure
|
|
82
|
-
|
|
83
|
-
```
|
|
84
|
-
anchor-engine-node/
|
|
85
|
-
├── README.md # Start here - Quick start & usage
|
|
86
|
-
├── CHANGELOG.md # What's new (v4.8.0)
|
|
87
|
-
├── CONTRIBUTING.md # How to contribute
|
|
88
|
-
│
|
|
89
|
-
├── docs/
|
|
90
|
-
│ ├── API.md # ✅ NEW - Complete API reference
|
|
91
|
-
│ ├── DEPLOYMENT.md # ✅ NEW - Deployment guide
|
|
92
|
-
│ ├── TROUBLESHOOTING.md # ✅ NEW - Troubleshooting
|
|
93
|
-
│ ├── whitepaper.md # STAR algorithm paper
|
|
94
|
-
│ ├── code-patterns.md # Code patterns
|
|
95
|
-
│ ├── INDEX.md # This file - navigation hub
|
|
96
|
-
│ └── arxiv/ # arXiv submission docs
|
|
97
|
-
│
|
|
98
|
-
├── specs/
|
|
99
|
-
│ ├── spec.md # System spec with diagrams
|
|
100
|
-
│ ├── API-ROUTE-MAP.md # Detailed API spec
|
|
101
|
-
│ ├── plan.md # Roadmap
|
|
102
|
-
│ ├── tasks.md # Current tasks
|
|
103
|
-
│ ├── current-standards/ # ✅ Active standards (001-010)
|
|
104
|
-
│ ├── archive-standards/ # Historical standards (059-200+)
|
|
105
|
-
│ └── archive-legacy/ # Legacy docs
|
|
106
|
-
│
|
|
107
|
-
├── engine/
|
|
108
|
-
│ └── src/
|
|
109
|
-
│ └── README.md # ✅ NEW - Source code overview
|
|
110
|
-
│
|
|
111
|
-
├── tests/
|
|
112
|
-
│ └── README.md # ✅ NEW - Testing guide
|
|
113
|
-
│
|
|
114
|
-
├── benchmarks/
|
|
115
|
-
│ └── README.md # Benchmarking framework
|
|
116
|
-
│
|
|
117
|
-
└── mcp-server/
|
|
118
|
-
└── README.md # MCP server integration
|
|
119
|
-
```
|
|
120
|
-
|
|
121
|
-
---
|
|
122
|
-
|
|
123
|
-
## 🎓 Learning Path
|
|
124
|
-
|
|
125
|
-
### Beginner (Just Getting Started)
|
|
126
|
-
1. **[README.md](../README.md)** - Installation & first query
|
|
127
|
-
2. **[docs/API.md](API.md)** - API basics
|
|
128
|
-
3. **[CHANGELOG.md](../CHANGELOG.md)** - Recent features
|
|
129
|
-
|
|
130
|
-
### Intermediate (Understanding the System)
|
|
131
|
-
1. **[specs/spec.md](../specs/spec.md)** - Full system specification
|
|
132
|
-
2. **[specs/current-standards/004-streaming-search.md](../specs/current-standards/004-streaming-search.md)** - Search algorithm
|
|
133
|
-
3. **[specs/current-standards/010-radial-distillation-v2.md](../specs/current-standards/010-radial-distillation-v2.md)** - Distillation v2.0
|
|
134
|
-
4. **[engine/src/README.md](../engine/src/README.md)** - Source overview
|
|
135
|
-
|
|
136
|
-
### Advanced (Deep Dive)
|
|
137
|
-
1. **[docs/whitepaper.md](whitepaper.md)** - Theoretical foundation
|
|
138
|
-
2. **[tests/README.md](../tests/README.md)** - Test suite
|
|
139
|
-
3. **[specs/current-standards/](../specs/current-standards/)** - All active standards
|
|
140
|
-
4. **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - Production deployment
|
|
141
|
-
|
|
142
|
-
### Contributor (Writing Code)
|
|
143
|
-
1. **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Contribution guidelines
|
|
144
|
-
2. **[engine/src/README.md](../engine/src/README.md)** - Source structure
|
|
145
|
-
3. **[tests/README.md](../tests/README.md)** - Testing requirements
|
|
146
|
-
4. **[specs/current-standards/](../specs/current-standards/)** - Architecture standards
|
|
147
|
-
|
|
148
|
-
---
|
|
149
|
-
|
|
150
|
-
## 🔬 Recent Updates (v4.8.0 - Mar 18, 2026)
|
|
151
|
-
|
|
152
|
-
### New Features
|
|
153
|
-
- **Session Index** - Two-tier memory retrieval (index → targeted fetch)
|
|
154
|
-
- **MCP Write Operations** - `anchor_ingest_text` and `anchor_ingest_file` tools
|
|
155
|
-
- **Paste & Ingest UI** - Quick text ingestion via Web UI
|
|
156
|
-
- **Philosophy Documentation** - Core principles embedded throughout docs
|
|
157
|
-
|
|
158
|
-
### New Documentation
|
|
159
|
-
- **docs/API.md** - Complete API reference
|
|
160
|
-
- **docs/DEPLOYMENT.md** - Deployment guide (all platforms)
|
|
161
|
-
- **docs/TROUBLESHOOTING.md** - Troubleshooting by category
|
|
162
|
-
- **engine/src/README.md** - Source code overview
|
|
163
|
-
- **tests/README.md** - Testing guide
|
|
164
|
-
|
|
165
|
-
### Documentation Consolidation
|
|
166
|
-
- Merged architecture diagrams into `specs/spec.md`
|
|
167
|
-
- Archived 7 redundant historical documents
|
|
168
|
-
- Updated all links to point to current docs
|
|
169
|
-
|
|
170
|
-
---
|
|
171
|
-
|
|
172
|
-
## 📁 Documentation Categories
|
|
173
|
-
|
|
174
|
-
### User-Facing
|
|
175
|
-
| Document | Audience | Purpose |
|
|
176
|
-
|----------|----------|---------|
|
|
177
|
-
| README.md | All users | Quick start & usage |
|
|
178
|
-
| docs/API.md | Developers | API reference |
|
|
179
|
-
| docs/DEPLOYMENT.md | DevOps | Deployment guide |
|
|
180
|
-
| docs/TROUBLESHOOTING.md | All users | Fix common issues |
|
|
181
|
-
| mcp-server/README.md | MCP users | MCP integration |
|
|
182
|
-
|
|
183
|
-
### Developer-Facing
|
|
184
|
-
| Document | Audience | Purpose |
|
|
185
|
-
|----------|----------|---------|
|
|
186
|
-
| engine/src/README.md | Contributors | Source overview |
|
|
187
|
-
| tests/README.md | Contributors | Testing guide |
|
|
188
|
-
| benchmarks/README.md | Contributors | Performance testing |
|
|
189
|
-
| specs/current-standards/ | Contributors | Architecture standards |
|
|
190
|
-
|
|
191
|
-
### Academic/Research
|
|
192
|
-
| Document | Audience | Purpose |
|
|
193
|
-
|----------|----------|---------|
|
|
194
|
-
| docs/whitepaper.md | Researchers | STAR algorithm paper |
|
|
195
|
-
| specs/spec.md | Architects | System specification |
|
|
196
|
-
| docs/arxiv/ | Researchers | arXiv submission |
|
|
197
|
-
|
|
198
|
-
---
|
|
199
|
-
|
|
200
|
-
## 🔗 External Resources
|
|
201
|
-
|
|
202
|
-
- **GitHub Repository:** https://github.com/RSBalchII/anchor-engine-node
|
|
203
|
-
- **License:** AGPL-3.0
|
|
204
|
-
- **NPM Packages:** @rbalchii/* (native modules)
|
|
205
|
-
- **DOI:** https://doi.org/10.5281/zenodo.18841399
|
|
206
|
-
|
|
207
|
-
---
|
|
208
|
-
|
|
209
|
-
## 📞 Support & Contribution
|
|
210
|
-
|
|
211
|
-
### Getting Help
|
|
212
|
-
- Check **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** for common issues
|
|
213
|
-
- Review **[specs/spec.md](../specs/spec.md)** for system understanding
|
|
214
|
-
- Read **[CHANGELOG.md](../CHANGELOG.md)** for recent fixes
|
|
215
|
-
|
|
216
|
-
### Contributing
|
|
217
|
-
1. Read **[CONTRIBUTING.md](../CONTRIBUTING.md)** for guidelines
|
|
218
|
-
2. Review **[engine/src/README.md](../engine/src/README.md)** for source structure
|
|
219
|
-
3. Follow **[specs/current-standards/](../specs/current-standards/)** for architecture
|
|
220
|
-
4. Run **[tests/README.md](../tests/README.md)** test suite before submitting
|
|
221
|
-
|
|
222
|
-
---
|
|
223
|
-
|
|
224
|
-
**Last Updated:** March 18, 2026
|
|
225
|
-
**Version:** 4.8.0
|
|
226
|
-
**Status:** ✅ Production Ready
|
|
1
|
+
# Anchor Engine - Documentation Index
|
|
2
|
+
|
|
3
|
+
**Version:** 4.8.0 | **Updated:** March 18, 2026 | **Status:** ✅ Production Ready
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 📚 Quick Navigation
|
|
8
|
+
|
|
9
|
+
### Getting Started
|
|
10
|
+
- **[README.md](../README.md)** - Quick start, installation, usage guide
|
|
11
|
+
- **[CHANGELOG.md](../CHANGELOG.md)** - Version history (latest: v4.8.0)
|
|
12
|
+
- **[CONTRIBUTING.md](../CONTRIBUTING.md)** - How to contribute
|
|
13
|
+
|
|
14
|
+
### Core Documentation
|
|
15
|
+
- **[docs/API.md](API.md)** - Complete API reference
|
|
16
|
+
- **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - Deployment guide (local, Docker, VPS, K8s)
|
|
17
|
+
- **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Troubleshooting guide
|
|
18
|
+
- **[docs/whitepaper.md](whitepaper.md)** - STAR Algorithm whitepaper
|
|
19
|
+
- **[specs/spec.md](../specs/spec.md)** - System specification with architecture diagrams
|
|
20
|
+
- **[specs/current-standards/](../specs/current-standards/)** - Active architecture standards (001-010)
|
|
21
|
+
|
|
22
|
+
### Development
|
|
23
|
+
- **[engine/src/README.md](../engine/src/README.md)** - Source code overview
|
|
24
|
+
- **[tests/README.md](../tests/README.md)** - Testing guide
|
|
25
|
+
- **[benchmarks/README.md](../benchmarks/README.md)** - Benchmarking framework
|
|
26
|
+
- **[mcp-server/README.md](../mcp-server/README.md)** - MCP server integration
|
|
27
|
+
|
|
28
|
+
---
|
|
29
|
+
|
|
30
|
+
## 🎯 Documentation by Use Case
|
|
31
|
+
|
|
32
|
+
### "I want to install and run Anchor Engine"
|
|
33
|
+
→ Start with **[README.md](../README.md)** - Quick Start section
|
|
34
|
+
|
|
35
|
+
### "I need API documentation"
|
|
36
|
+
→ Read **[docs/API.md](API.md)** - Complete API reference with examples
|
|
37
|
+
|
|
38
|
+
### "I want to deploy to production"
|
|
39
|
+
→ Follow **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - All deployment options
|
|
40
|
+
|
|
41
|
+
### "Something's not working"
|
|
42
|
+
→ Check **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** - Common issues and fixes
|
|
43
|
+
|
|
44
|
+
### "I need to understand the system architecture"
|
|
45
|
+
→ Study **[specs/spec.md](../specs/spec.md)** - System specification with diagrams
|
|
46
|
+
|
|
47
|
+
### "I'm researching the theory behind Anchor Engine"
|
|
48
|
+
→ Read **[docs/whitepaper.md](whitepaper.md)** - Academic paper
|
|
49
|
+
|
|
50
|
+
### "I want to understand the search algorithm"
|
|
51
|
+
→ See **[specs/current-standards/004-streaming-search.md](../specs/current-standards/004-streaming-search.md)**
|
|
52
|
+
|
|
53
|
+
### "How does distillation work?"
|
|
54
|
+
→ Read **[specs/current-standards/010-radial-distillation-v2.md](../specs/current-standards/010-radial-distillation-v2.md)**
|
|
55
|
+
|
|
56
|
+
### "I want to contribute code"
|
|
57
|
+
→ Start with **[engine/src/README.md](../engine/src/README.md)** - Source overview
|
|
58
|
+
|
|
59
|
+
### "I need to write tests"
|
|
60
|
+
→ Follow **[tests/README.md](../tests/README.md)** - Testing guide
|
|
61
|
+
|
|
62
|
+
### "I want to connect via MCP"
|
|
63
|
+
→ See **[mcp-server/README.md](../mcp-server/README.md)** - MCP integration
|
|
64
|
+
|
|
65
|
+
---
|
|
66
|
+
|
|
67
|
+
## 📊 Key Metrics (v4.8.0)
|
|
68
|
+
|
|
69
|
+
| Metric | Value | Status |
|
|
70
|
+
|--------|-------|--------|
|
|
71
|
+
| **Context Retrieval** | 618k chars | ✅ +18% vs whitepaper |
|
|
72
|
+
| **Memory Peak** | 510MB | ✅ -70% vs whitepaper |
|
|
73
|
+
| **Search Latency** | <200ms (p95) | ✅ Optimized |
|
|
74
|
+
| **Ingestion Throughput** | 1,200 mol/sec | ✅ Verified |
|
|
75
|
+
| **Deduplication Rate** | 40-50% | ✅ With SimHash |
|
|
76
|
+
| **Session Index** | NEW in v4.8.0 | ✅ Two-tier retrieval |
|
|
77
|
+
| **MCP Write Ops** | NEW in v4.8.0 | ✅ Opt-in ingest |
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
|
|
81
|
+
## 🗂️ Document Structure
|
|
82
|
+
|
|
83
|
+
```
|
|
84
|
+
anchor-engine-node/
|
|
85
|
+
├── README.md # Start here - Quick start & usage
|
|
86
|
+
├── CHANGELOG.md # What's new (v4.8.0)
|
|
87
|
+
├── CONTRIBUTING.md # How to contribute
|
|
88
|
+
│
|
|
89
|
+
├── docs/
|
|
90
|
+
│ ├── API.md # ✅ NEW - Complete API reference
|
|
91
|
+
│ ├── DEPLOYMENT.md # ✅ NEW - Deployment guide
|
|
92
|
+
│ ├── TROUBLESHOOTING.md # ✅ NEW - Troubleshooting
|
|
93
|
+
│ ├── whitepaper.md # STAR algorithm paper
|
|
94
|
+
│ ├── code-patterns.md # Code patterns
|
|
95
|
+
│ ├── INDEX.md # This file - navigation hub
|
|
96
|
+
│ └── arxiv/ # arXiv submission docs
|
|
97
|
+
│
|
|
98
|
+
├── specs/
|
|
99
|
+
│ ├── spec.md # System spec with diagrams
|
|
100
|
+
│ ├── API-ROUTE-MAP.md # Detailed API spec
|
|
101
|
+
│ ├── plan.md # Roadmap
|
|
102
|
+
│ ├── tasks.md # Current tasks
|
|
103
|
+
│ ├── current-standards/ # ✅ Active standards (001-010)
|
|
104
|
+
│ ├── archive-standards/ # Historical standards (059-200+)
|
|
105
|
+
│ └── archive-legacy/ # Legacy docs
|
|
106
|
+
│
|
|
107
|
+
├── engine/
|
|
108
|
+
│ └── src/
|
|
109
|
+
│ └── README.md # ✅ NEW - Source code overview
|
|
110
|
+
│
|
|
111
|
+
├── tests/
|
|
112
|
+
│ └── README.md # ✅ NEW - Testing guide
|
|
113
|
+
│
|
|
114
|
+
├── benchmarks/
|
|
115
|
+
│ └── README.md # Benchmarking framework
|
|
116
|
+
│
|
|
117
|
+
└── mcp-server/
|
|
118
|
+
└── README.md # MCP server integration
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
---
|
|
122
|
+
|
|
123
|
+
## 🎓 Learning Path
|
|
124
|
+
|
|
125
|
+
### Beginner (Just Getting Started)
|
|
126
|
+
1. **[README.md](../README.md)** - Installation & first query
|
|
127
|
+
2. **[docs/API.md](API.md)** - API basics
|
|
128
|
+
3. **[CHANGELOG.md](../CHANGELOG.md)** - Recent features
|
|
129
|
+
|
|
130
|
+
### Intermediate (Understanding the System)
|
|
131
|
+
1. **[specs/spec.md](../specs/spec.md)** - Full system specification
|
|
132
|
+
2. **[specs/current-standards/004-streaming-search.md](../specs/current-standards/004-streaming-search.md)** - Search algorithm
|
|
133
|
+
3. **[specs/current-standards/010-radial-distillation-v2.md](../specs/current-standards/010-radial-distillation-v2.md)** - Distillation v2.0
|
|
134
|
+
4. **[engine/src/README.md](../engine/src/README.md)** - Source overview
|
|
135
|
+
|
|
136
|
+
### Advanced (Deep Dive)
|
|
137
|
+
1. **[docs/whitepaper.md](whitepaper.md)** - Theoretical foundation
|
|
138
|
+
2. **[tests/README.md](../tests/README.md)** - Test suite
|
|
139
|
+
3. **[specs/current-standards/](../specs/current-standards/)** - All active standards
|
|
140
|
+
4. **[docs/DEPLOYMENT.md](DEPLOYMENT.md)** - Production deployment
|
|
141
|
+
|
|
142
|
+
### Contributor (Writing Code)
|
|
143
|
+
1. **[CONTRIBUTING.md](../CONTRIBUTING.md)** - Contribution guidelines
|
|
144
|
+
2. **[engine/src/README.md](../engine/src/README.md)** - Source structure
|
|
145
|
+
3. **[tests/README.md](../tests/README.md)** - Testing requirements
|
|
146
|
+
4. **[specs/current-standards/](../specs/current-standards/)** - Architecture standards
|
|
147
|
+
|
|
148
|
+
---
|
|
149
|
+
|
|
150
|
+
## 🔬 Recent Updates (v4.8.0 - Mar 18, 2026)
|
|
151
|
+
|
|
152
|
+
### New Features
|
|
153
|
+
- **Session Index** - Two-tier memory retrieval (index → targeted fetch)
|
|
154
|
+
- **MCP Write Operations** - `anchor_ingest_text` and `anchor_ingest_file` tools
|
|
155
|
+
- **Paste & Ingest UI** - Quick text ingestion via Web UI
|
|
156
|
+
- **Philosophy Documentation** - Core principles embedded throughout docs
|
|
157
|
+
|
|
158
|
+
### New Documentation
|
|
159
|
+
- **docs/API.md** - Complete API reference
|
|
160
|
+
- **docs/DEPLOYMENT.md** - Deployment guide (all platforms)
|
|
161
|
+
- **docs/TROUBLESHOOTING.md** - Troubleshooting by category
|
|
162
|
+
- **engine/src/README.md** - Source code overview
|
|
163
|
+
- **tests/README.md** - Testing guide
|
|
164
|
+
|
|
165
|
+
### Documentation Consolidation
|
|
166
|
+
- Merged architecture diagrams into `specs/spec.md`
|
|
167
|
+
- Archived 7 redundant historical documents
|
|
168
|
+
- Updated all links to point to current docs
|
|
169
|
+
|
|
170
|
+
---
|
|
171
|
+
|
|
172
|
+
## 📁 Documentation Categories
|
|
173
|
+
|
|
174
|
+
### User-Facing
|
|
175
|
+
| Document | Audience | Purpose |
|
|
176
|
+
|----------|----------|---------|
|
|
177
|
+
| README.md | All users | Quick start & usage |
|
|
178
|
+
| docs/API.md | Developers | API reference |
|
|
179
|
+
| docs/DEPLOYMENT.md | DevOps | Deployment guide |
|
|
180
|
+
| docs/TROUBLESHOOTING.md | All users | Fix common issues |
|
|
181
|
+
| mcp-server/README.md | MCP users | MCP integration |
|
|
182
|
+
|
|
183
|
+
### Developer-Facing
|
|
184
|
+
| Document | Audience | Purpose |
|
|
185
|
+
|----------|----------|---------|
|
|
186
|
+
| engine/src/README.md | Contributors | Source overview |
|
|
187
|
+
| tests/README.md | Contributors | Testing guide |
|
|
188
|
+
| benchmarks/README.md | Contributors | Performance testing |
|
|
189
|
+
| specs/current-standards/ | Contributors | Architecture standards |
|
|
190
|
+
|
|
191
|
+
### Academic/Research
|
|
192
|
+
| Document | Audience | Purpose |
|
|
193
|
+
|----------|----------|---------|
|
|
194
|
+
| docs/whitepaper.md | Researchers | STAR algorithm paper |
|
|
195
|
+
| specs/spec.md | Architects | System specification |
|
|
196
|
+
| docs/arxiv/ | Researchers | arXiv submission |
|
|
197
|
+
|
|
198
|
+
---
|
|
199
|
+
|
|
200
|
+
## 🔗 External Resources
|
|
201
|
+
|
|
202
|
+
- **GitHub Repository:** https://github.com/RSBalchII/anchor-engine-node
|
|
203
|
+
- **License:** AGPL-3.0
|
|
204
|
+
- **NPM Packages:** @rbalchii/* (native modules)
|
|
205
|
+
- **DOI:** https://doi.org/10.5281/zenodo.18841399
|
|
206
|
+
|
|
207
|
+
---
|
|
208
|
+
|
|
209
|
+
## 📞 Support & Contribution
|
|
210
|
+
|
|
211
|
+
### Getting Help
|
|
212
|
+
- Check **[docs/TROUBLESHOOTING.md](TROUBLESHOOTING.md)** for common issues
|
|
213
|
+
- Review **[specs/spec.md](../specs/spec.md)** for system understanding
|
|
214
|
+
- Read **[CHANGELOG.md](../CHANGELOG.md)** for recent fixes
|
|
215
|
+
|
|
216
|
+
### Contributing
|
|
217
|
+
1. Read **[CONTRIBUTING.md](../CONTRIBUTING.md)** for guidelines
|
|
218
|
+
2. Review **[engine/src/README.md](../engine/src/README.md)** for source structure
|
|
219
|
+
3. Follow **[specs/current-standards/](../specs/current-standards/)** for architecture
|
|
220
|
+
4. Run **[tests/README.md](../tests/README.md)** test suite before submitting
|
|
221
|
+
|
|
222
|
+
---
|
|
223
|
+
|
|
224
|
+
**Last Updated:** March 18, 2026
|
|
225
|
+
**Version:** 4.8.0
|
|
226
|
+
**Status:** ✅ Production Ready
|
|
@@ -0,0 +1,166 @@
|
|
|
1
|
+
# Anchor Engine Node - Markdown Files Inventory
|
|
2
|
+
|
|
3
|
+
**Generated:** 2026-03-20
|
|
4
|
+
**Excluded:** `node_modules/`, `specs/`, `README.md`, `CHANGELOG.md`, `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, `BUILDING.md`, `INSTALL*.md`, `PULL_REQUEST_TEMPLATE.md`
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 📋 Summary
|
|
9
|
+
|
|
10
|
+
| Category | Count | Location |
|
|
11
|
+
|----------|-------|----------|
|
|
12
|
+
| Personal/Bio Files | 47 | `mirrored_brain/@inbox/` |
|
|
13
|
+
| Project Documentation | 13 | `docs/`, root |
|
|
14
|
+
| Engine Documentation | 4 | `engine/` |
|
|
15
|
+
| Testing Documentation | 4 | Various |
|
|
16
|
+
| Benchmarks | 2 | `benchmarks/` |
|
|
17
|
+
| Jules Config | 2 | `.jules/` |
|
|
18
|
+
| **Total** | **72** | |
|
|
19
|
+
|
|
20
|
+
---
|
|
21
|
+
|
|
22
|
+
## 📁 Files by Category
|
|
23
|
+
|
|
24
|
+
### Personal & Bio Files (mirrored_brain/@inbox/)
|
|
25
|
+
These appear to be personal notes, resumes, and biographical content:
|
|
26
|
+
|
|
27
|
+
1. `mirrored_brain/@inbox/ECE-update-9-3-25.md`
|
|
28
|
+
2. `mirrored_brain/@inbox/N8N-context-plan.md`
|
|
29
|
+
3. `mirrored_brain/@inbox/Plan.md`
|
|
30
|
+
4. `mirrored_brain/@inbox/diagram-architectural-brief.md`
|
|
31
|
+
5. `mirrored_brain/@inbox/design-pattern.md`
|
|
32
|
+
6. `mirrored_brain/@inbox/forTheLawyer.md`
|
|
33
|
+
7. `mirrored_brain/@inbox/llama3.md`
|
|
34
|
+
8. `mirrored_brain/@inbox/graphr1-training.md`
|
|
35
|
+
9. `mirrored_brain/@inbox/architecture-overview.md`
|
|
36
|
+
10. `mirrored_brain/@inbox/symbiotic-charter.md`
|
|
37
|
+
11. `mirrored_brain/@inbox/jade-context.md`
|
|
38
|
+
12. `mirrored_brain/@inbox/Robert-Balch-II-Resume.md`
|
|
39
|
+
13. `mirrored_brain/@inbox/Diagnosis ASD_ADHD - Jun 25, 2022.md`
|
|
40
|
+
14. `mirrored_brain/@inbox/categories.md`
|
|
41
|
+
15. `mirrored_brain/@inbox/urls.md`
|
|
42
|
+
16. `mirrored_brain/@inbox/user-bio.md`
|
|
43
|
+
17. `mirrored_brain/@inbox/new-deepseek.md`
|
|
44
|
+
18. `mirrored_brain/@inbox/resume_updates.md`
|
|
45
|
+
19. `mirrored_brain/@inbox/dao-extension-algorithm.md`
|
|
46
|
+
20. `mirrored_brain/@inbox/the-contextual-intelligence-hypothesis.md`
|
|
47
|
+
21. `mirrored_brain/@inbox/get-work-seen.md`
|
|
48
|
+
22. `mirrored_brain/@inbox/patent-pending.md`
|
|
49
|
+
23. `mirrored_brain/@inbox/sym-opp-engine.md`
|
|
50
|
+
24. `mirrored_brain/@inbox/graph_R1_data_schema.md`
|
|
51
|
+
25. `mirrored_brain/@inbox/injector_error_handling_protocol.md`
|
|
52
|
+
26. `mirrored_brain/@inbox/path_to_patent.md`
|
|
53
|
+
27. `mirrored_brain/@inbox/path_to_completion.md`
|
|
54
|
+
28. `mirrored_brain/@inbox/partner.md`
|
|
55
|
+
29. `mirrored_brain/@inbox/Email-History-Santiago-Delgado.md`
|
|
56
|
+
30. `mirrored_brain/@inbox/DMA-Proposal-Initial.md`
|
|
57
|
+
31. `mirrored_brain/@inbox/Email-History-RHowell.md`
|
|
58
|
+
32. `mirrored_brain/@inbox/Job-Context.md`
|
|
59
|
+
33. `mirrored_brain/@inbox/AI-Architect-Execution-Plan.md`
|
|
60
|
+
34. `mirrored_brain/@inbox/Proposal-Santa-Rosa.md`
|
|
61
|
+
35. `mirrored_brain/@inbox/Job-Summary.md`
|
|
62
|
+
36. `mirrored_brain/@inbox/Sandia-Labs-Action-Plan.md`
|
|
63
|
+
37. `mirrored_brain/@inbox/SDG.md`
|
|
64
|
+
38. `mirrored_brain/@inbox/Warp-Ready-AI-Arch-Plan.md`
|
|
65
|
+
39. `mirrored_brain/@inbox/history-summary.md`
|
|
66
|
+
40. `mirrored_brain/@inbox/skills.md`
|
|
67
|
+
41. `mirrored_brain/@inbox/appearance.md`
|
|
68
|
+
42. `mirrored_brain/@inbox/ethos.md`
|
|
69
|
+
43. `mirrored_brain/@inbox/life-history.md`
|
|
70
|
+
44. `mirrored_brain/@inbox/thinking-processes.md`
|
|
71
|
+
45. `mirrored_brain/@inbox/distiller.md`
|
|
72
|
+
46. `mirrored_brain/@inbox/containment-flow.md`
|
|
73
|
+
47. `mirrored_brain/@inbox/core-events.md`
|
|
74
|
+
48. `mirrored_brain/@inbox/A-Special-Session.md`
|
|
75
|
+
49. `mirrored_brain/@inbox/memories.md`
|
|
76
|
+
50. `mirrored_brain/@inbox/Google AI Studio session January 9-12th 2026.md`
|
|
77
|
+
51. `mirrored_brain/@inbox/Google AI Studio session January 3-9th 2026.md`
|
|
78
|
+
52. `mirrored_brain/@inbox/Morning-Surrender.md`
|
|
79
|
+
53. `mirrored_brain/@inbox/Sybil-History.md`
|
|
80
|
+
|
|
81
|
+
### Project Documentation (Root & docs/)
|
|
82
|
+
|
|
83
|
+
54. `PROJECT_STATE_ASSESSMENT.md` - Current project status
|
|
84
|
+
55. `NPM_PUBLISH_SUMMARY.md` - NPM publishing guide
|
|
85
|
+
56. `TESTING_FRAMEWORK_COMPLETE.md` - Testing framework documentation
|
|
86
|
+
57. `TODAY_SUMMARY.md` - Daily summary
|
|
87
|
+
58. `paper.md` - Project paper
|
|
88
|
+
59. `search-test-report.md` - Search testing results
|
|
89
|
+
60. `docs/STAR_Whitepaper_Executive.md` - Executive whitepaper
|
|
90
|
+
61. `docs/API.md` - API documentation
|
|
91
|
+
62. `docs/DEPLOYMENT.md` - Deployment guide
|
|
92
|
+
63. `docs/TROUBLESHOOTING.md` - Troubleshooting guide
|
|
93
|
+
64. `docs/INDEX.md` - Documentation index
|
|
94
|
+
65. `docs/arxiv/joss_response.md` - JOSS paper response
|
|
95
|
+
66. `docs/arxiv/review.md` - Arxiv review
|
|
96
|
+
67. `docs/code-patterns.md` - Code patterns documentation
|
|
97
|
+
68. `docs/whitepaper.md` - Technical whitepaper
|
|
98
|
+
|
|
99
|
+
### Engine Documentation
|
|
100
|
+
|
|
101
|
+
69. `engine/TAXONOMY.md` - Engine taxonomy
|
|
102
|
+
70. `engine/context_data/synonyms/synonym-ring-auto-summary.md` - Synonym ring summary
|
|
103
|
+
71. `engine/data/synonym-ring-summary.md` - Synonym ring summary
|
|
104
|
+
72. `engine/docs/TAG_MODULATION.md` - Tag modulation guide
|
|
105
|
+
73. `engine/tests/unit/GITHUB_INGESTION_TESTING.md` - GitHub ingestion tests
|
|
106
|
+
|
|
107
|
+
### Testing Documentation
|
|
108
|
+
|
|
109
|
+
74. `TESTING.md` - Main testing guide
|
|
110
|
+
75. `packages/anchor-ui/TESTING.md` - UI package testing
|
|
111
|
+
76. `packages/anchor-ui/TESTING_SUMMARY.md` - UI testing summary
|
|
112
|
+
77. `tests/unit/CONTEXT_QUALITY_TESTS_README.md` - Context quality tests
|
|
113
|
+
|
|
114
|
+
### Benchmarks
|
|
115
|
+
|
|
116
|
+
78. `benchmarks/baseline-performance.md` - Performance benchmarks
|
|
117
|
+
79. `benchmarks/metrics-documentation.md` - Metrics documentation
|
|
118
|
+
|
|
119
|
+
### Configuration Files
|
|
120
|
+
|
|
121
|
+
80. `.jules/bolt.md` - Jules Bolt configuration
|
|
122
|
+
81. `.jules/palette.md` - Jules palette configuration
|
|
123
|
+
|
|
124
|
+
### Sample Data
|
|
125
|
+
|
|
126
|
+
82. `sample-data/architecture-overview.md` - Sample architecture overview
|
|
127
|
+
|
|
128
|
+
---
|
|
129
|
+
|
|
130
|
+
## 🎯 Recommendations
|
|
131
|
+
|
|
132
|
+
### Files to Consider for specs/ Directory
|
|
133
|
+
These files contain important standards or processes that could be formalized:
|
|
134
|
+
|
|
135
|
+
- `engine/docs/TAG_MODULATION.md` - Engine behavior specification
|
|
136
|
+
- `engine/TAXONOMY.md` - Core taxonomy standard
|
|
137
|
+
- `benchmarks/metrics-documentation.md` - Metrics standard
|
|
138
|
+
- `docs/code-patterns.md` - Code patterns standard
|
|
139
|
+
|
|
140
|
+
### Files to Review for Ingestion into Anchor Engine
|
|
141
|
+
Personal/bio files that might be valuable context for the AI:
|
|
142
|
+
|
|
143
|
+
- `mirrored_brain/@inbox/user-bio.md`
|
|
144
|
+
- `mirrored_brain/@inbox/skills.md`
|
|
145
|
+
- `mirrored_brain/@inbox/thinking-processes.md`
|
|
146
|
+
- `mirrored_brain/@inbox/distiller.md`
|
|
147
|
+
- `mirrored_brain/@inbox/Robert-Balch-II-Resume.md`
|
|
148
|
+
|
|
149
|
+
### Files to Archive or Remove
|
|
150
|
+
Old session files that may have been superseded by Anchor Engine data:
|
|
151
|
+
|
|
152
|
+
- `TODAY_SUMMARY.md`
|
|
153
|
+
- `search-test-report.md`
|
|
154
|
+
- `Google AI Studio session *.md` (if ingested into Anchor)
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## 📊 Statistics
|
|
159
|
+
|
|
160
|
+
- **Total MD files found:** 82
|
|
161
|
+
- **Personal notes:** 53 (65%)
|
|
162
|
+
- **Technical documentation:** 18 (22%)
|
|
163
|
+
- **Testing/benchmarks:** 6 (7%)
|
|
164
|
+
- **Configuration:** 2 (2%)
|
|
165
|
+
- **Sample data:** 1 (1%)
|
|
166
|
+
- **Excluded (node_modules, specs):** ~2400+ files
|