Skip to content

Commit 96c0a0b

Browse files
clanker-loverclaude
andcommitted
v1.0.0: Architecture Mode + Enhanced AI Summaries
- Architecture mode: zoomable dependency graph visualization - Level 0: module graph with inter-module dependencies - Level 1: file graph within modules, ghost nodes for external deps - Export MD for context extraction at each level - Enhanced AI prompts with dependency context - New response format: ROLE, SUMMARY, KEY CONCEPTS, PSEUDOCODE - D3.js force-directed graph visualization - Deep-link support (?node=id parameter) - Fix: export_module_md was called without module prefix - 212 tests passing Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 6d0de7e commit 96c0a0b

14 files changed

Lines changed: 2483 additions & 59 deletions

README.md

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# codedocent
22

3-
<img width="1658" height="2158" alt="Screenshot_2026-02-09_13-17-06" src="https://github.com/user-attachments/assets/ff097ead-69ec-4618-b7b7-2b99c60ac57e" />
3+
<!-- Screenshot coming soon -->
44

55
**Code visualization for non-programmers.**
66

@@ -12,6 +12,33 @@ You're staring at a codebase you didn't write — maybe thousands of files acros
1212

1313
Codedocent parses the codebase into a navigable, visual block structure and explains each piece in plain English. It's an AI code analysis tool — use a cloud provider for speed or run locally through Ollama for full privacy. Point it at any codebase and get a structural overview you can explore interactively, understand quickly, and share as a static HTML file.
1414

15+
## What's new in v1.0.0
16+
17+
### Architecture Mode
18+
19+
Visualize your codebase as a zoomable dependency graph. Three levels of detail:
20+
21+
- **Level 0 — Modules**: See all modules as nodes with dependency edges between them
22+
- **Level 1 — Files**: Drill into a module to see its files and their internal + external dependencies
23+
- **Level 2 — Code**: Click through to the existing CodeDocent file view (functions, classes, complexity)
24+
25+
Export MD button at each level generates structured context you can feed to AI tools.
26+
27+
```bash
28+
codedocent /path/to/code --arch # jump straight to architecture view
29+
```
30+
31+
Or choose option 4 in the setup wizard.
32+
33+
### Enhanced AI Summaries
34+
35+
AI analysis now understands where each file sits in the system:
36+
37+
- **Dependency context** — the prompt tells the AI what this file imports and what imports it
38+
- **ROLE** — what job does this code do? Foundation, orchestrator, utility, entry point?
39+
- **KEY CONCEPTS** — main functions, classes, and data structures with one-line descriptions
40+
- **Better prompts** — explains code in terms of data flow and system role, not just syntax
41+
1542
## Who this is for
1643

1744
- **Developers onboarding onto an unfamiliar codebase** — get oriented in minutes instead of days
@@ -23,7 +50,9 @@ Codedocent parses the codebase into a navigable, visual block structure and expl
2350

2451
## What you see
2552

26-
Nested, color-coded blocks representing directories, files, classes, and functions — the entire structure of a codebase laid out visually. Each block shows a plain English summary, a pseudocode translation, and quality warnings (green/yellow/red). Click any block to drill down; breadcrumbs navigate you back up. You can export code from any block or paste replacement code back into the source file. AI explanations come from your choice of cloud provider or local Ollama.
53+
Nested, color-coded blocks representing directories, files, classes, and functions — the entire structure of a codebase laid out visually. Each block shows a plain English summary, key concepts, pseudocode, and quality warnings. Click any block to drill down; breadcrumbs navigate you back up. You can export code from any block or paste replacement code back into the source file.
54+
55+
In architecture mode, a D3.js force-directed graph shows modules and files as nodes with directed dependency edges. Click any node to drill deeper.
2756

2857
## Install
2958

@@ -38,6 +67,7 @@ Requires Python 3.10+. Cloud AI needs an API key set in an env var (e.g. `OPENAI
3867
```bash
3968
codedocent # setup wizard — walks you through everything
4069
codedocent /path/to/code # interactive mode (recommended)
70+
codedocent /path/to/code --arch # architecture mode — dependency graph
4171
codedocent /path/to/code --full # full analysis, static HTML output
4272
codedocent --gui # graphical launcher
4373
codedocent /path/to/code --cloud openai # use OpenAI
@@ -47,7 +77,7 @@ codedocent /path/to/code --cloud custom --endpoint https://my-llm/v1/chat/comple
4777

4878
## How it works
4979

50-
Parses code structure with tree-sitter, scores quality with static analysis, and sends individual blocks to a cloud AI provider or local Ollama model for plain English summaries and pseudocode. Interactive mode analyzes on click — typically 1-2 seconds per block. Full mode analyzes everything upfront into a self-contained HTML file you can share.
80+
Parses code structure with tree-sitter, scores quality with static analysis, and sends individual blocks to a cloud AI provider or local Ollama model for plain English summaries and pseudocode. Interactive mode analyzes on click — typically 1-2 seconds per block. Full mode analyzes everything upfront into a self-contained HTML file you can share. Architecture mode builds a dependency graph from import statements and renders it as a zoomable D3 visualization.
5181

5282
## AI options
5383

0 commit comments

Comments
 (0)