Magma Wiki¶
Welcome! This is Magma's living documentation. Everything here lives as Markdown files in a GitHub repo — edit anything by clicking the pencil icon at the top-right of a page, or by cloning the repo and opening a pull request.
Getting started¶
- New to Magma? Start with Onboarding.
- Shipping something? See Deployments.
- Something on fire? See Incident response.
- Writing a new page? See the style guide.
How this wiki works¶
Source of truth
The repo is the source of truth. The published site is just a rendered view of docs/ on the main branch. Merge to main, site updates in ~90 seconds.
Any change goes through a pull request. Two reasons: a second pair of eyes catches mistakes, and the PR itself becomes the history of why something changed.
Conventions¶
- One topic per page. If a page grows past a screen or two, split it.
- Link liberally. A wiki's value is in its cross-references.
- Prefer concrete examples over abstract description.
- Date anything that will go stale (runbooks, on-call rotations, vendor contacts).