Documentation

Start with the question you arrived with.

I want to understand the system

I want to know	Read
What stealth is, and what Stealth Scale publishes	What stealth is
Why the code lives in four repositories, and what each one holds	The repositories
How a product is put together at run time	How a product is composed

I am working in a stealth repository

I want to know	Read
How a repository is laid out, and how a package is named	Repositories and packages
What the gates enforce: formatting, lint, types, tests, releases	Code standards
What a docblock says, and on what	Docblocks
How a commit message is written	Commit messages
Where a document goes, and how it is written	Documentation
The four files of a component: source, stories, page and spec	Documenting a component
How to build, check and land a change to this repository	Contributing

Where things go

A page in reference/ describes and does not instruct: what a rule is, what a field means, what a tool guarantees. A page in explanation/ says why the system is shaped the way it is and sends the rules elsewhere. A page in how-to/ gives the steps for one goal, and there is none here yet: the first arrives with the first published package.

Design proposals, decisions and the roadmap are numbered records under rfc/, adr/ and roadmap/. Until a repository is cut out of the monorepo, its records stay in that repository; this one holds none yet.