Skip to content

Latest commit

 

History

History
34 lines (21 loc) · 1.8 KB

README.md

File metadata and controls

34 lines (21 loc) · 1.8 KB

Rigel public design docs

Design records and decisions for Rigel's public repositories: Compass, meissa, the forks, and every other public repo.

Each project gets its own directory, docs/designs/<project>/. Its decisions live at docs/designs/<project>/decisions/<area>/DL-NNN.md.

Each fork has a directory named after its repository, with no owner prefix: for example docs/designs/oh-my-pi/ for RigelBuild/oh-my-pi. Fork design records go there, not in the fork repository. A new fork gets its directory when its first record lands.

Everything in this repository is public. Do not cite private repositories.

Layout

Every public project has a directory at docs/designs/<project>/. Store design records there and decisions at decisions/<area>/DL-NNN.md. The ledger gate discovers project directories, so no config edit is needed for a new one.

Claiming decision IDs

The counter uses the single public-repo surface designs for every project. The claim client needs an explicit surface list, so bun run claim uses design-ledger.claim.config.json; the gate config leaves surfaces out so it discovers projects.

bun run claim --ref RIG-<n> --lane <bookmark> --surface designs

Check the returned ID before creating docs/designs/<project>/decisions/<area>/DL-NNN.md. Do not rerun a failed claim blindly; the counter may have consumed an ID.

Checks and site

Run bun install, bun test, bun run gate, bun run ref-gate, rumdl check ., biome ci ., and bun run build. The gather step reads checked-in Markdown under docs/, renders decision pages and per-project decision indexes into generated content, and the Astro Starlight site publishes to the Cloudflare Pages project docs.

Cloudflare assigns the Pages hostname for project docs; the site does not configure a custom domain.