Skip to content

Commit 89698cf

Browse files
committed
docs: fix markdownlint MD040, VSC label, and absolute privacy claim
1 parent b7a1eca commit 89698cf

3 files changed

Lines changed: 23 additions & 23 deletions

File tree

docs/architecture.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,12 @@ OpenCodeIntel is a RAG-based (Retrieval-Augmented Generation) code intelligence
1212

1313
## High-Level Architecture
1414

15-
```
15+
```text
1616
┌─────────────────────────────────────────────────────────────────┐
1717
│ Developer's Machine │
1818
│ │
1919
│ ┌──────────┐ ┌────────────────┐ ┌──────────────────┐ │
20-
│ │ Claude │ │ Cursor / VSC │ │ Gemini CLI / │ │
20+
│ │ Claude │ │ Cursor / VS Code │ │ Gemini CLI / │ │
2121
│ │ Code │ │ + Copilot │ │ Any MCP client │ │
2222
│ └────┬─────┘ └───────┬────────┘ └────────┬─────────┘ │
2323
│ │ │ │ │
@@ -56,7 +56,7 @@ OpenCodeIntel is a RAG-based (Retrieval-Augmented Generation) code intelligence
5656

5757
## Indexing Pipeline (RAG — Knowledge Base Construction)
5858

59-
```
59+
```text
6060
Repository (GitHub URL or local path)
6161
6262
@@ -119,7 +119,7 @@ Repository (GitHub URL or local path)
119119

120120
## Query Pipeline (RAG — Retrieval + Context Assembly)
121121

122-
```
122+
```text
123123
User Task: "add rate limiting to the settings endpoints"
124124
125125
@@ -179,7 +179,7 @@ Assembled Context (Markdown):
179179

180180
## DNA Extraction Pipeline (Prompt Engineering Component)
181181

182-
```
182+
```text
183183
Repository Files
184184
185185
@@ -214,7 +214,7 @@ Repository Files
214214

215215
## Dependency Analysis Pipeline
216216

217-
```
217+
```text
218218
Repository Source Files
219219
220220
@@ -251,7 +251,7 @@ Repository Source Files
251251

252252
## MCP Protocol Layer
253253

254-
```
254+
```text
255255
MCP Client (Claude Code / Cursor / etc.)
256256
257257
│ JSON-RPC over stdio OR HTTP
@@ -299,7 +299,7 @@ MCP Client (Claude Code / Cursor / etc.)
299299

300300
## Data Flow: End-to-End
301301

302-
```
302+
```text
303303
1. Developer adds repo URL at opencodeintel.com
304304
305305
2. Backend clones repo, tree-sitter parses all files

docs/examples/README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ These examples use the hosted instance at `mcp.opencodeintel.com`.
88
## Example 1: Per-Task Context Assembly
99

1010
**User task given to Claude Code:**
11-
```
11+
```text
1212
add rate limiting to the POST /api/v1/settings endpoint
1313
```
1414

1515
**OCI `get_context_for_task` response:**
1616

17-
```
17+
```text
1818
CONTEXT PACKAGE — assembled for: "add rate limiting to the POST /api/v1/settings endpoint"
1919
Token budget: 1500 | Tokens used: 1,387 | Files found: 3
2020
@@ -61,7 +61,7 @@ RULES (from AGENTS.md — matched to task)
6161
## Example 2: Semantic Code Search
6262

6363
**Query:**
64-
```
64+
```text
6565
search_code("authentication middleware JWT validation")
6666
```
6767

@@ -98,12 +98,12 @@ search_code("authentication middleware JWT validation")
9898
## Example 3: Codebase DNA Extraction
9999

100100
**Query:**
101-
```
101+
```text
102102
get_codebase_dna(repo_id="78aa181e-...")
103103
```
104104

105105
**Response (extracted architectural patterns):**
106-
```
106+
```text
107107
CODEBASE DNA — OpenCodeIntel Backend
108108
Extracted: 2025-04-24
109109
@@ -147,12 +147,12 @@ TYPE HINTS
147147
## Example 4: Impact Analysis
148148

149149
**Query:**
150-
```
150+
```text
151151
analyze_impact(repo_id="78aa181e-...", file_path="backend/middleware/auth.py")
152152
```
153153

154154
**Response:**
155-
```
155+
```text
156156
IMPACT ANALYSIS — backend/middleware/auth.py
157157
158158
Direct dependents (files that import this):
@@ -179,12 +179,12 @@ Risk assessment: HIGH
179179
## Example 5: Dependency Graph
180180

181181
**Query:**
182-
```
182+
```text
183183
get_dependency_graph(repo_id="78aa181e-...")
184184
```
185185

186186
**Partial response (most connected nodes):**
187-
```
187+
```text
188188
DEPENDENCY GRAPH — OpenCodeIntel Backend
189189
190190
Most imported files (critical nodes):

docs/project-report.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
**Project:** AI-Powered Code Intelligence System
55
**Author:** Devanshu Chicholikar
66
**Institution:** Northeastern University
7-
**Date:** April 2025
7+
**Report date (snapshot):** April 2025
88
**Live System:** https://opencodeintel.com
99
**Repository:** https://github.com/OpenCodeIntel/opencodeintel
1010

@@ -44,7 +44,7 @@ An MCP server exposes all capabilities as tools consumable by any MCP-compatible
4444

4545
### Architecture Diagram
4646

47-
```
47+
```text
4848
Repository → tree-sitter parsing → OpenAI embeddings → Pinecone
4949
↘ import graph → Supabase
5050
@@ -68,7 +68,7 @@ RAG is the architectural foundation of OpenCodeIntel.
6868

6969
The knowledge base is built by parsing source code at function granularity using tree-sitter (an incremental parsing library that produces ASTs for Python, JavaScript, TypeScript, and TSX). Each parsed function is converted into rich embedding text:
7070

71-
```
71+
```text
7272
File: backend/middleware/auth.py
7373
Function: _validate_jwt
7474
Parameters: token: str
@@ -108,7 +108,7 @@ Each vector stores metadata: `file_path`, `function_name`, `repo_id`, `chunk_typ
108108
The `get_context_for_task` tool is the primary prompt engineering component. It solves a specific problem: even with the right files retrieved, an AI assistant still needs to know the project's conventions (what exception class to use, what auth pattern to follow, where to put new files). Without this, the AI generates correct-looking but wrong code.
109109

110110
The context assembler reads rule files in priority order:
111-
```
111+
```text
112112
CLAUDE.md → AGENTS.md → .cursorrules → .codeintel/rules.md
113113
→ CONVENTIONS.md → .github/copilot-instructions.md
114114
→ CODING_GUIDELINES.md
@@ -269,7 +269,7 @@ The context assembly feature could theoretically be used to extract sensitive pa
269269
The embedding model (OpenAI `text-embedding-3-small`) may perform better on English-language identifiers and comments than on other languages. Codebases with non-English naming conventions may see lower retrieval recall. This is a known limitation.
270270

271271
**Copyright**
272-
OCI does not reproduce or redistribute source code. It stores vector embeddings (real-valued floating point arrays) which cannot be reverse-engineered to reconstruct source code. Retrieval returns file paths and function signatures to help the AI locate relevant code — not the code itself verbatim (unless the user has authorized access to that repo).
272+
OCI does not reproduce or redistribute source code. It stores vector embeddings (real-valued floating point arrays) which significantly reduces the risk of reconstructing original source code. Retrieval returns file paths and function signatures to help the AI locate relevant code — not the code itself verbatim (unless the user has authorized access to that repo).
273273

274274
**Content Filtering**
275275
The system does not filter for malicious code patterns. It indexes whatever the user points it at. Users are responsible for ensuring they have authorization to index the repositories they connect.
@@ -289,7 +289,7 @@ The system does not filter for malicious code patterns. It indexes whatever the
289289

290290
## Appendix: Repository Structure
291291

292-
```
292+
```text
293293
opencodeintel/
294294
├── backend/ FastAPI backend (Python 3.11+)
295295
│ ├── services/

0 commit comments

Comments
 (0)