Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
a25ce4d
feat(docs): Phase 1 - Upgraded docs components and layout
DevanshuNEU Feb 14, 2026
047c02d
fix(docs): remove AI-looking documentation badge from hero
DevanshuNEU Feb 14, 2026
98e256f
feat(docs): Phase 2 - Add QuickStart and Features pages
DevanshuNEU Feb 14, 2026
2be9c70
feat(docs): Phase 2 continued - MCP and Deployment pages
DevanshuNEU Feb 14, 2026
39834eb
feat(docs): Phase 3 - Complete API Reference pages
DevanshuNEU Feb 14, 2026
dbe2c22
fix: scroll to top on page navigation
DevanshuNEU Feb 14, 2026
277321e
fix: remove broken sidebar links (Authentication, Configuration, Cont…
DevanshuNEU Feb 14, 2026
1e0d075
fix(docs): correct API endpoint URLs to /api/v1 prefix
DevanshuNEU Feb 14, 2026
9d30050
feat(docs): add accurate Architecture and Contributing pages
DevanshuNEU Feb 14, 2026
ddf0534
fix: update CONTRIBUTING.md to use Bun instead of npm
DevanshuNEU Feb 14, 2026
e8b5a4e
fix(docs): correct pagination flow from Self-Hosting to API Overview
DevanshuNEU Feb 14, 2026
158441d
fix: remove emojis from Makefile
DevanshuNEU Feb 15, 2026
6ef5061
fix: remove duplicate DocsRelated and DocsPagination from DocsCards.tsx
DevanshuNEU Feb 15, 2026
ea22776
fix: wrap clipboard API calls in try/catch in DocsCodeBlock
DevanshuNEU Feb 15, 2026
9d17802
fix: consolidate imports and add missing mobile nav sections in DocsL…
DevanshuNEU Feb 15, 2026
04877dd
fix: remove duplicate badge and prerequisites from DocsPageHeader
DevanshuNEU Feb 15, 2026
563c2a2
fix: add missing pages to DocsSearch index
DevanshuNEU Feb 15, 2026
df7dcd7
fix: use exact path matching for isActive in sidebar navigation
DevanshuNEU Feb 15, 2026
1e72257
fix: connector line now hides on last Step using parent selector
DevanshuNEU Feb 15, 2026
d0aa0a6
fix: remove repo_id from impact endpoint request body example
DevanshuNEU Feb 15, 2026
2b84b1a
fix: remove JS comment from JSON example in APIRepositoriesPage
DevanshuNEU Feb 15, 2026
7e1516e
fix: correct API URL in CodeStyleAnalysisPage to /api/v1/repos/{id}/s…
DevanshuNEU Feb 15, 2026
b5d3041
fix: correct API URL in DependencyAnalysisPage to /api/v1
DevanshuNEU Feb 15, 2026
61ded4f
fix: correct impact API example to POST with /api/v1 and JSON body
DevanshuNEU Feb 15, 2026
7a0d98e
fix: correct search API URL in SemanticSearchPage to /api/v1/search
DevanshuNEU Feb 15, 2026
f429aa1
fix: change prerequisites from Node.js to Bun in QuickStartPage
DevanshuNEU Feb 15, 2026
4432455
fix: relax CLAUDE.md rules and add code fence language
DevanshuNEU Feb 15, 2026
dcb2254
fix: use explicit null check for timeEstimate in DocsPageHeader
DevanshuNEU Feb 15, 2026
74b67c3
fix: hoist groupedPages to module scope in DocsSearch
DevanshuNEU Feb 15, 2026
e12dd69
fix: use angle brackets for API key placeholder to avoid Gitleaks war…
DevanshuNEU Feb 15, 2026
48d43f0
fix: add curl example to Code Style section in APIAnalysisPage
DevanshuNEU Feb 15, 2026
3b4e416
fix: show platform-aware keyboard shortcut hint in DocsSearch
DevanshuNEU Feb 15, 2026
ea2882f
docs: add DEFERRED.md to track skipped refactoring work
DevanshuNEU Feb 15, 2026
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
68 changes: 68 additions & 0 deletions CLAUDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
# CodeIntel Development Rules

## Code Style

### General
- NO emojis anywhere - not in code, comments, docs, or commit messages
- Prefer files under 200 lines. Larger files allowed when logically cohesive.
- Comments explain WHY, not WHAT. Keep them brief.
- No decorative headers or ASCII art
- Casual tone in comments - write like a human, not a robot

### JSDoc Policy
- JSDoc allowed for public API functions and exported hooks
- Keep JSDoc minimal - document params and return types, not obvious behavior
- Approved files using JSDoc: `frontend/src/services/playground-api.ts`, `frontend/src/config/api.ts`, `frontend/src/hooks/useViewTransition.ts`

### Large File Exceptions
These files exceed 200 lines but are approved due to logical cohesion:
- `backend/routes/playground.py`
- `backend/services/dna_extractor.py`
- `frontend/src/components/DependencyGraph/index.tsx`

### Frontend (TypeScript/React)
- Package manager: **Bun only**. Never npm, never yarn.
- Always `bun install`, `bun run dev`, `bun run build`
- Never delete `bun.lock` or create `package-lock.json`
- Use shadcn/ui components over custom UI
- Tailwind for styling, no CSS files
- Functional components with hooks, no class components

### Backend (Python)
- Python 3.11+ required
- Type hints on all function signatures
- Async/await for I/O operations
- PEP 8 style, max 120 char lines
- Use existing patterns from `services/` directory

### Commits
- Format: `type: description` (e.g., `fix: remove broken link`)
- Types: feat, fix, docs, refactor, test, chore
- No emojis in commit messages
- Keep commits focused - one change per commit

## Architecture

### Project Structure
```plaintext
backend/ # FastAPI, Python 3.11+
frontend/ # React 18, TypeScript, Vite, Bun
mcp-server/ # MCP protocol server
```

### API Versioning
- All endpoints use `/api/v1/` prefix
- Version config in `backend/config/api.py`

### Key Services
- `indexer_optimized.py` - Code parsing and embedding
- `dependency_analyzer.py` - Import graph extraction
- `style_analyzer.py` - Convention detection
- `dna_extractor.py` - Architectural pattern extraction

## What NOT to Do

- Don't use npm (use Bun)
- Don't add emojis
- Don't write verbose comments
- Don't add "AI-looking" badges or decorations
9 changes: 6 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,18 @@ pip install -r requirements.txt
cp .env.example .env
# Add your API keys to .env

# Set up frontend
# Set up frontend (MUST use Bun, not npm!)
cd ../frontend
npm install
bun install

# Run tests
cd ../backend
pytest tests/ -v
```

> **Important:** The frontend uses Bun exclusively. Do NOT use npm or yarn.
> Install Bun: `curl -fsSL https://bun.sh/install | bash`

## How to Contribute

### Reporting Bugs
Expand Down Expand Up @@ -65,7 +68,7 @@ pytest tests/ -v
- Use TypeScript strict mode
- Prefer functional components
- Use Tailwind for styling
- Run: `npm run build` to check for errors
- Run: `bun run build` to check for errors

## Testing

Expand Down
36 changes: 36 additions & 0 deletions DEFERRED.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# Deferred Work

Items intentionally skipped for future PRs.

---

## PR: feature/docs-overhaul

### 1. Extract shared EndpointHeader component
**Priority:** Low
**Effort:** 30 min
**Files affected:**
- `frontend/src/pages/api/APIRepositoriesPage.tsx`
- `frontend/src/pages/api/APIAnalysisPage.tsx`
- `frontend/src/pages/api/APISearchPage.tsx`
- `frontend/src/pages/api/APIOverviewPage.tsx`

**What:** All 4 API doc pages duplicate the endpoint header markup (colored method badge + path in bordered container). APIRepositoriesPage already has a local `EndpointHeader` component - extract it to `@/components/docs` and reuse.

**Saves:** ~40 lines of duplication

**When to do:** Next time any of these pages need changes, or during a cleanup sprint.

---

### 2. Consolidate navigation data source
**Priority:** Medium
**Effort:** 1-2 hours
**Files affected:**
- `frontend/src/components/docs/DocsSidebar.tsx` (navigation)
- `frontend/src/components/docs/DocsSearch.tsx` (docsPages)
- `frontend/src/components/docs/DocsLayout.tsx` (mobileNavigation)

**What:** Same page list maintained in 3 places. Adding a page requires updating all 3. Extract single `docsNavigation` data source and derive variants from it.

**When to do:** Before adding more doc pages, or if someone forgets to update all 3.
10 changes: 5 additions & 5 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,16 @@

# Default target - rebuild frontend
f frontend:
@echo "🔄 Rebuilding frontend..."
@echo "Rebuilding frontend..."
@docker compose build frontend
@docker compose up -d frontend
@echo "Done"
@echo "Done"

b backend:
@echo "🔄 Rebuilding backend..."
@echo "Rebuilding backend..."
@docker compose build backend
@docker compose up -d backend
@echo "Done"
@echo "Done"

all:
@docker compose build
Expand All @@ -39,7 +39,7 @@ status ps:
@docker compose ps

clean:
@echo "⚠️ Full rebuild (slow)..."
@echo "Full rebuild (slow)..."
@docker compose build --no-cache
@docker compose up -d

Expand Down
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,9 +123,9 @@ python -m venv venv && source venv/bin/activate
pip install -r requirements.txt
python main.py

# Frontend (new terminal)
# Frontend (new terminal) - MUST use Bun!
cd frontend
npm install && npm run dev
bun install && bun run dev
```

</details>
Expand Down
Loading