Skip to content

Latest commit

 

History

History
58 lines (45 loc) · 2.99 KB

File metadata and controls

58 lines (45 loc) · 2.99 KB

Documentation Index

Getting Started

Document Description
Quick Start Get running in 5 minutes
User Manual Complete usage guide (installation through troubleshooting)

Reference

Document Description
Installation Detailed installation for all platforms
Windows Installation Windows-specific setup guide
Configuration All config options, env vars, and defaults
CLI Reference Every wqm command with flags and examples
MCP Tools Tool parameters, schemas, and example calls
LLM Integration Best practices for Claude and other AI assistants
Architecture Component overview and data flow

Specifications

Technical specifications for developers and contributors.

Document Description
Overview Specification index
Architecture System design and component diagram
Collection Architecture Multi-tenant collection model
Document Taxonomy Document types and processing
Write Path Queue architecture and write flow
Rules System Behavioral rules design
File Watching File watcher and debouncing
Code Intelligence Tree-sitter, LSP, and code graph
API Reference MCP tools and gRPC services
Search Instrumentation Analytics and metrics
Keyword/Tag Extraction Extraction pipeline
Grammar Runtime ONNX Runtime and tree-sitter
Configuration Configuration specification
Deployment Build, packaging, and distribution
Future Development Roadmap and parking lot

Architecture Decision Records

Document Description
ADR-001 Canonical collection names
ADR-002 Daemon-only Qdrant writes
ADR-003 Daemon owns SQLite

Reading Paths

New user: Quick StartUser ManualLLM Integration

Advanced user: CLI Reference + MCP Tools + Configuration

Developer/Contributor: ArchitectureSpecificationsADRs