trevon/brick
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: trim the README and split usage, resolution and development out #6

Merged
trevon merged 2 commits from docs/readme-split into main 2026-09-25 02:54:21 +00:00
Conversation 0 Commits 2 Files changed 4 +316 -251
trevon commented 2026-09-25 02:49:17 +00:00
Owner
Copy link

Problem

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.

Solution

The README is now a 70-line overview (what Brick is, evidence lanes, languages, quick start, commands, limits, links). The rest moves to:

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

Architecture docs are linked, not repeated. Every relative link and anchor resolves, and no factual statement from the old README was dropped (checked by diffing its code-formatted terms against the new docs).

Docs only; no code changes.

Written by Claude (Claude Code) at the maintainer's direction.

## Problem 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. ## Solution The README is now a 70-line overview (what Brick is, evidence lanes, languages, quick start, commands, limits, links). The rest moves to: - `docs/usage.md` — every command (build, render, check with diff and policy gates, mcp, setup), Fold/SARIF and p4c layering, the P4 pilot, what the model contains. - `docs/resolution.md` — per-language name resolution as the code now implements it (after #5), what is not handled, P4 limits, the regression corpus, schema version 4. - `docs/development.md` — build and test commands, the quality gate, the toolchain pin, the brick-sast skill. Architecture docs are linked, not repeated. Every relative link and anchor resolves, and no factual statement from the old README was dropped (checked by diffing its code-formatted terms against the new docs). Docs only; no code changes. --- Written by Claude (Claude Code) at the maintainer's direction.
docs: trim the README and split usage, resolution and development out
Some checks failed
build / build-linux (pull_request) Successful in 1m4s
Details
build / build-macos (pull_request) Has been cancelled
Details
build / release (pull_request) Has been cancelled
Details
d88238c986
 
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.
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
Details
build / build-macos (pull_request) Has been cancelled
Details
build / release (pull_request) Has been cancelled
Details
4de9884a54
trevon merged commit 8b1e52042e into main 2026-09-25 02:54:21 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
Labels
Clear labels
No items
No labels
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
trevon/brick!6
No description provided.