Commit graph

2 commits

Author SHA1 Message Date
trvon
4de9884a54
Merge main into docs/readme-split: carry #7's caller-status docs into the split
Some checks failed
build / build-linux (pull_request) Successful in 1m4s
build / build-macos (pull_request) Has been cancelled
build / release (pull_request) Has been cancelled
2026-09-24 20:53:21 -06:00
trvon
d88238c986
docs: trim the README and split usage, resolution and development out
Some checks failed
build / build-linux (pull_request) Successful in 1m4s
build / build-macos (pull_request) Has been cancelled
build / release (pull_request) Has been cancelled
The README had grown to 254 lines covering an overview, every command,
the Fold/SARIF and p4c import contracts, the P4 pilot, per-language
resolution rules, limits, schema history, development and the agent
skill. It is now a 70-line overview (what Brick is, evidence lanes,
languages, quick start, commands, limits, links), and the rest lives in:

- docs/usage.md: every command (build, render, check with diff and
  policy gates, mcp, setup), Fold/SARIF and p4c layering, the P4 pilot,
  and what the model contains.
- docs/resolution.md: per-language name resolution as the code now
  implements it, what is not handled, P4 limits, the regression corpus
  and schema version 4.
- docs/development.md: build and test commands, the quality gate, the
  toolchain pin, and the brick-sast skill.

Architecture docs are linked, not repeated. "What v0.1 provides" and
the milestone note are folded into usage.md and the roadmap pointer.
Every relative link and anchor resolves.
2026-09-24 20:42:00 -06:00