@@ -101,16 +101,19 @@ from code2logic.llm import get_client, BaseLLMClient
101101from code2logic.tools import run_benchmark, CodeReviewer
102102```
103103
104- ## Output Formats
104+ ## 📋 Output Formats
105105
106106### Markdown (default)
107+
107108Human-readable documentation with:
109+
108110- Project structure tree with hub markers (★)
109111- Dependency graphs with PageRank scores
110112- Classes with methods and intents
111113- Functions with signatures and descriptions
112114
113115### Compact
116+
114117Ultra-compact format optimized for LLM context:
115118
116119``` text
@@ -124,12 +127,14 @@ HUBS: evolution-manager llm-orchestrator
124127```
125128
126129### JSON
130+
127131Machine-readable format for:
132+
128133- RAG (Retrieval-Augmented Generation)
129134- Database storage
130135- Further analysis
131136
132- ## Configuration
137+ ## 🔧 Configuration
133138
134139### Library Status
135140Check which features are available:
@@ -198,15 +203,17 @@ status = get_library_status()
198203# {'tree_sitter': True, 'networkx': True, ...}
199204```
200205
201- ## Analysis Features
206+ ## 📊 Analysis Features
202207
203208### Dependency Analysis
209+
204210- ** PageRank** - Identifies most important modules
205211- ** Hub detection** - Central modules marked with ★
206212- ** Cycle detection** - Find circular dependencies
207213- ** Clustering** - Group related modules
208214
209215### Intent Generation
216+
210217Functions get human-readable descriptions:
211218
212219``` yaml
@@ -217,6 +224,7 @@ methods:
217224` ` `
218225
219226### Similarity Detection
227+
220228Find duplicate and similar functions:
221229
222230` ` ` yaml
@@ -226,7 +234,7 @@ Similar Functions:
226234 - services/jwt.ts::verifyToken (85%)
227235` ` `
228236
229- ## Architecture
237+ ## 🏗️ Architecture
230238
231239` ` ` text
232240code2logic/
@@ -240,7 +248,7 @@ code2logic/
240248└── cli.py # Command-line interface
241249```
242250
243- ## Integration Examples
251+ ## 🔌 Integration Examples
244252
245253### With Claude/ChatGPT
246254
@@ -276,7 +284,7 @@ for module in data['modules']:
276284 )
277285```
278286
279- ## Development
287+ ## 🧪 Development
280288
281289### Setup
282290
@@ -307,28 +315,28 @@ ruff check code2logic
307315black code2logic
308316```
309317
310- ## Performance
318+ ## 📈 Performance
311319
312- | Codebase Size | Files | Lines | Time | Output Size |
313- | --- | --- | --- | --- | --- |
314- | Small | 10 | 1K | <1s | ~ 5KB |
315- | Medium | 100 | 30K | ~ 2s | ~ 50KB |
316- | Large | 500 | 150K | ~ 10s | ~ 200KB |
320+ | Codebase Size| Files| Lines| Time| Output Size|
321+ | ---| ---| ---| ---| ---|
322+ | Small| 10 | 1K | <1s| ~ 5KB|
323+ | Medium| 100| 30K| ~ 2s| ~ 50KB|
324+ | Large| 500| 150K| ~ 10s| ~ 200KB|
317325
318326Compact format is ~ 10-15x smaller than Markdown.
319327
320- ## Code Reproduction Benchmarks
328+ ## 🔬 Code Reproduction Benchmarks
321329
322330Code2Logic can reproduce code from specifications using LLMs. Benchmark results:
323331
324332### Format Comparison (Token Efficiency)
325333
326- | Format | Score | Token Efficiency | Spec Tokens | Runs OK |
327- | --- | --- | --- | --- | --- |
328- | ** YAML** | ** 71.1%** | 42.1 | ** 366** | 66.7% |
329- | ** Markdown** | 65.6% | ** 48.7** | 385 | ** 100%** |
330- | JSON | 61.9% | 23.7 | 605 | 66.7% |
331- | Gherkin | 51.3% | 19.1 | 411 | 66.7% |
334+ | Format| Score| Token Efficiency| Spec Tokens| Runs OK|
335+ | ---| ---| ---| ---| ---|
336+ | ** YAML** | ** 71.1%** | 42.1| ** 366** | 66.7%|
337+ | ** Markdown** | 65.6%| ** 48.7** | 385| ** 100%** |
338+ | JSON| 61.9%| 23.7| 605| 66.7%|
339+ | Gherkin| 51.3%| 19.1| 411| 66.7%|
332340
333341### Key Findings
334342
0 commit comments