Commit 487827a
authored
Add Documentation for Experimental Codebase Indexing Feature (#204)
* Add complete documentation for the new experimental Codebase Indexing feature that enables semantic code search using AI embeddings.
## New Documentation
- **docs/features/experimental/codebase-indexing.mdx**: Comprehensive feature documentation covering:
- Semantic search capabilities using Tree-sitter parsing and AI embeddings
- Setup requirements for OpenAI/Ollama embedding providers and Qdrant vector database
- Configuration steps and status indicators
- File processing with smart code parsing and automatic filtering
- Best practices for model selection and security considerations
- Current limitations and future enhancements
- Privacy and security considerations
## Updated Navigation & Cross-references
- **sidebars.ts**: Added Codebase Indexing to Features > Experimental navigation menu
- **docs/features/experimental/experimental-features.md**:
- Added Codebase Indexing to experimental features list
- Added screenshot showing the experimental features settings panel
- **docs/faq.md**: Added FAQ entries explaining:
- What Codebase Indexing is and its semantic search capabilities
- Cost considerations for embedding generation and vector storage
## Assets
- **static/img/experimental-features/experimental-features.png**: Screenshot of experimental features settings panel
## Technical Details Covered
- Tree-sitter integration for AST-based code parsing
- Support for both OpenAI and Ollama embedding providers
- Qdrant vector database integration with local and cloud deployment options
- Incremental indexing with file watching and hash-based caching
- Smart file filtering excluding binaries, large files, and common ignore patterns
- codebase_search tool integration for AI-powered code discovery
The documentation is targeted at a semi-technical audience and provides practical setup guidance while explaining the underlying semantic search technology.
* Add comprehensive documentation for the experimental codebase_search tool and reorganize the tool category structure to better distinguish between read and search functionality.
## New Documentation
- **docs/advanced-usage/available-tools/codebase-search.md**: Complete tool documentation covering:
- Semantic search capabilities using AI embeddings and vector similarity
- Integration with experimental Codebase Indexing feature with proper warning
- Parameters, requirements, and configuration dependencies (OpenAI/Ollama + Qdrant)
- Detailed workflow explanation from query processing to result formatting
- Best practices for effective semantic queries vs. traditional text search
- Directory scoping capabilities and result interpretation guidelines
- Usage examples demonstrating authentication, database, error handling, and testing searches
- Similarity scoring explanation and result structure details
## Updated Navigation & Organization
- **sidebars.ts**: Added codebase_search to Available Tools navigation menu
- **docs/advanced-usage/available-tools/tool-use-overview.md**: Reorganized tool categories:
- Split "Read Group" into separate "Read Group" and "Search Group" categories
- **Read Group**: File system reading and exploration (read_file, list_files, list_code_definition_names)
- **Search Group**: Pattern and semantic searching (search_files, codebase_search)
- Updated tool group table to reflect the new logical separation
- Updated common patterns example to showcase semantic search with codebase_search
- Improved categorization aligns with actual tool usage patterns
## Technical Coverage
The documentation accurately reflects the tool's implementation including:
- CodeIndexManager integration and availability validation
- Dual output format for AI and UI consumption
- Vector similarity search with cosine similarity and 0.4 threshold
- Performance optimizations (50 result limit, Tree-sitter language support)
- Path filtering and workspace-relative result formatting
- Integration with experimental indexing infrastructure
This provides users with clear guidance on semantic code search capabilities while maintaining appropriate warnings about the experimental nature of the feature.
* Refactor code structure for improved readability and maintainability1 parent 30f1862 commit 487827a
File tree
8 files changed
+430
-4
lines changed- docs
- advanced-usage/available-tools
- features/experimental
- static/img
- codebase-indexing
- experimental-features
8 files changed
+430
-4
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
| 1 | + | |
| 2 | + | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
| 7 | + | |
| 8 | + | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
| 12 | + | |
| 13 | + | |
| 14 | + | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
| 21 | + | |
| 22 | + | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
| 34 | + | |
| 35 | + | |
| 36 | + | |
| 37 | + | |
| 38 | + | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
| 53 | + | |
| 54 | + | |
| 55 | + | |
| 56 | + | |
| 57 | + | |
| 58 | + | |
| 59 | + | |
| 60 | + | |
| 61 | + | |
| 62 | + | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
| 111 | + | |
| 112 | + | |
| 113 | + | |
| 114 | + | |
| 115 | + | |
| 116 | + | |
| 117 | + | |
| 118 | + | |
| 119 | + | |
| 120 | + | |
| 121 | + | |
| 122 | + | |
| 123 | + | |
| 124 | + | |
| 125 | + | |
| 126 | + | |
| 127 | + | |
| 128 | + | |
| 129 | + | |
| 130 | + | |
| 131 | + | |
| 132 | + | |
| 133 | + | |
| 134 | + | |
| 135 | + | |
| 136 | + | |
| 137 | + | |
| 138 | + | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
| 147 | + | |
| 148 | + | |
| 149 | + | |
| 150 | + | |
| 151 | + | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
| 14 | + | |
14 | 15 | | |
15 | 16 | | |
16 | 17 | | |
| |||
32 | 33 | | |
33 | 34 | | |
34 | 35 | | |
35 | | - | |
36 | 36 | | |
37 | 37 | | |
38 | 38 | | |
| 39 | + | |
| 40 | + | |
| 41 | + | |
| 42 | + | |
| 43 | + | |
| 44 | + | |
39 | 45 | | |
40 | 46 | | |
41 | 47 | | |
| |||
211 | 217 | | |
212 | 218 | | |
213 | 219 | | |
214 | | - | |
| 220 | + | |
215 | 221 | | |
216 | 222 | | |
217 | 223 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
136 | 136 | | |
137 | 137 | | |
138 | 138 | | |
| 139 | + | |
| 140 | + | |
| 141 | + | |
| 142 | + | |
| 143 | + | |
| 144 | + | |
| 145 | + | |
| 146 | + | |
139 | 147 | | |
140 | 148 | | |
141 | 149 | | |
| |||
148 | 156 | | |
149 | 157 | | |
150 | 158 | | |
151 | | - | |
| 159 | + | |
152 | 160 | | |
153 | 161 | | |
154 | 162 | | |
| |||
0 commit comments