.agents/memory/2026-02-23-documentation-gap-audit-update-plan.md

2026-02-23 Session Notes

Documentation Gap Audit & Update Plan

Nicholai initiated a comprehensive documentation audit session for the signetai project. A detailed plan was provided identifying and prioritizing documentation gaps across the codebase.

Key Findings

Priority 1 (Incorrect Content):

• DASHBOARD.md references non-existent UI tabs (DiagnosticsTab, AnalyticsTab, etc.); actual tabs are Config, Settings, Memory, Embeddings, Logs, Secrets, Skills
• DIAGNOSTICS.md missing the update domain (weight 0.11)

Priority 2 (Missing API Endpoints):

• Three undocumented endpoints: GET /api/embeddings/projection, GET /api/repair/embedding-gaps, POST /api/repair/re-embed
• CLAUDE.md endpoint table also needs these three entries

Priority 3 (New Subsystem):

• Tray app (packages/tray/, Tauri v2) shipped with zero documentation. Architecture: Rust handles tray lifecycle/menus, TypeScript polling loop for state detection. Adaptive polling: 5s when running, 2s when stopped. Linux uses systemd with fallback to bunx discovery.

Priority 4 (Pipeline Gaps):

• Three pipeline modules undocumented: provider.ts (Ollama/Claude LLM abstraction), reranker.ts (timeout-guarded search reranking), url-fetcher.ts (document ingest with 30s timeout, 10MB max)
• ARCHITECTURE.md schema section incomplete; needs full table of 16 tables across migrations

Priority 5-6: CLI embed subcommands and internal modules (content normalization, UMAP algorithm notes).

Deliverables

Eight documentation files require updates or creation, grouped by priority. Verification steps include grep checks, cross-reference validation, and schema consistency verification.