To install and use CodeGraph, start with the project README. To build it and send a change, see Contributing.
| Topic | Where to start |
|---|---|
| Architecture, build rules and platform validation | Project guide |
| Distribution and release packaging | Bundling |
| What telemetry collects, and how to turn it off | Telemetry |
| Release history | Changelog |
| Entries held for the viewer's launch | Viewer changelog |
| What languages and frameworks cover, and what's left | Framework coverage |
| Validating a language or framework on real repositories | Validation guide and coverage playbook |
| Checking a language by hand | Language verification guide |
| The browser viewer's design | Viewer design spec |
| The native extraction kernel | Kernel design |
- Design: architecture notes and feature proposals. Some describe planned work rather than what has shipped.
- Benchmarks: measurements and how they were taken. Read each against the revision and setup it records.
- Grammars: notes and patches for the parser grammars CodeGraph builds itself.
- Plans: implementation plans.
- Discussion notes: supporting notes from design discussions.