docs: add VitePress documentation site

- Add docs directory with VitePress configuration - Add GitHub Actions workflow for docs build and deploy - Support bilingual (English/Chinese) documentation - Include search, custom theme, and responsive design
2026-03-01 15:03:57 +08:00 · 2026-02-28 16:14:09 +08:00
parent ab65caec45
commit c3ddf7e322
136 changed files with 34486 additions and 0 deletions
--- a/docs/features/codexlens.md
+++ b/docs/features/codexlens.md
@@ -0,0 +1,115 @@
+# CodexLens Code Indexing
+
+## One-Liner
+
+**CodexLens is a semantic code search engine** — Based on vector databases and LSP integration, it enables AI to understand code semantics rather than just keyword matching.
+
+---
+
+## Pain Points Solved
+
+| Pain Point | Current State | CodexLens Solution |
+|------------|---------------|-------------------|
+| **Imprecise search** | Keywords can't find semantically related code | Semantic vector search |
+| **No context** | Search results lack call chain context | LSP integration provides reference chains |
+| **No understanding** | AI doesn't understand code relationships | Static analysis + semantic indexing |
+| **Slow navigation** | Manual file traversal | Instant semantic navigation |
+
+---
+
+## vs Traditional Methods
+
+| Dimension | Text Search | IDE Search | **CodexLens** |
+|-----------|-------------|------------|---------------|
+| Search type | Keyword | Keyword + symbol | **Semantic vector** |
+| Context | None | File-level | **Call chain + imports** |
+| AI-ready | No | No | **Direct AI consumption** |
+| Multi-file | Poor | Good | **Excellent** |
+
+---
+
+## Core Concepts
+
+| Concept | Description | Location |
+|---------|-------------|----------|
+| **Index** | Vector representation of code | `.codex-lens/index/` |
+| **Chunk** | Code segment for embedding | Configurable size |
+| **Retrieval** | Hybrid search (vector + keyword) | HybridSearch engine |
+| **LSP** | Language Server Protocol integration | Built-in LSP client |
+
+---
+
+## Usage
+
+### Indexing Project
+
+```bash
+ccw index
+ccw index --watch  # Continuous indexing
+```
+
+### Searching
+
+```bash
+ccw search "authentication logic"
+ccw search "where is user validation" --top 10
+```
+
+### Via MCP Tool
+
+```typescript
+// ACE semantic search
+mcp__ace-tool__search_context({
+  project_root_path: "/path/to/project",
+  query: "authentication logic"
+})
+```
+
+---
+
+## Configuration
+
+```json
+// ~/.codexlens/settings.json
+{
+  "embedding": {
+    "backend": "litellm",
+    "model": "Qwen/Qwen3-Embedding-8B",
+    "use_gpu": false
+  },
+  "indexing": {
+    "static_graph_enabled": true,
+    "chunk_size": 512
+  }
+}
+```
+
+---
+
+## Architecture
+
+```
+┌─────────────────────────────────────────┐
+│              CodexLens                   │
+├─────────────────────────────────────────┤
+│  ┌──────────┐  ┌──────────┐  ┌────────┐ │
+│  │  Parsers │  │ Chunker  │  │  LSP   │ │
+│  │(TS/Py/..)│  │          │  │ Client │ │
+│  └────┬─────┘  └────┬─────┘  └───┬────┘ │
+│       │             │            │       │
+│       └─────────────┼────────────┘       │
+│                     │                    │
+│              ┌──────┴──────┐             │
+│              │   Hybrid    │             │
+│              │   Search    │             │
+│              └─────────────┘             │
+└─────────────────────────────────────────┘
+```
+
+---
+
+## Related Links
+
+- [CLI Call](/features/cli) - AI model invocation
+- [Memory System](/features/memory) - Persistent context
+- [MCP Tools](/mcp/tools) - MCP integration