Documentation map
These documents are published at https://branes-ai.github.io/synapse/. The site is generated from this folder on every merge to main (plan): edit the documents here, never the site. index.mdx is the site’s landing page, and this file is its documentation map.
Start here:
- The GGML ecosystem: how the GGML ecosystem (GGUF, ggml, libllama, the conversion and quantization tools) is put together, and which part of it each synapse component corresponds to
- What a Llama model computes: what a Llama-family model computes, step by step, why it is built that way, what it costs, and where synapse’s numerics meet llama.cpp’s
| Folder | Contents |
|---|---|
| getting-started/ | Introduction, build & test, repository layout |
| arch/ | Architecture and design: the GGML ecosystem and where synapse fits, what a Llama model computes; later the GGUF loader, graph IR, memory planner and kernel dispatch |
| assessments/ | Analyses and trade studies: block-scaled dot performance, adopting MTL5’s block-scaled integer dot in the quantized kernels |
| sessions/ | Dated records of development sessions, kept in the repo and not published on the site |
| plan/ | Per-issue plans, each with its issues and PRs: docs site |
| adr/ | Architecture decision records: third-party license compatibility, no GPL code; port only from permissive sources |
The plans and the decisions are published on the architecture site, alongside every other repo’s plans and decisions and their status, rather than here.