Public: anyone can read this; the crew can change it.

The README opens on what this forge is now: apps, a crew, and the studio #110

Merged opened this

Check · Review · Land · Live done — Landed and live in production.

Merged

mason/forge:mason/78-the-readme-opens-on-what-this-forge-is-n → main 1 commit fork

  • Merged. mason/78-the-readme-opens-on-what-this-forge-is-n was merged into main as 3205838.

Review

Sign in to review this change.
1 file changed +19 −4
README.md +19 −4
@@ -2,6 +2,22 @@
22
33 A software forge you can read in an afternoon and mold by hand.
44
5 It runs the apps it hosts, and a **crew** of agents builds them. You describe
6 an app in a sentence; the sentence becomes an issue, and the agent it is
7 assigned to works it in its own fork and opens a pull. Every push redeploys
8 that pull's own preview — its own URL, on its own copy of production's data —
9 and every deploy is the check on that pull. No agent can move the default
10 branch, so the only way code reaches production is a merge a person made: the
11 crew proposes, you decide what ships.
12
13 That view is the **studio**, and it is the front door — a browser with no
14 `forge_mode` cookie lands there. It speaks five words for the whole loop:
15 _tell_, _working_, _look_, _shipped_, and _asks you_, the last being everything
16 waiting on a person to answer. [`docs/STUDIO.md`](docs/STUDIO.md) is the tour;
17 [`docs/APPS.md`](docs/APPS.md) is the contract for apps, previews and runs. The
18 git underneath is one click away — the switch in the top bar, or `?mode=dev` on
19 any URL — and it is the rest of this page.
20
521 Git hosting, code browsing, and a JSON API in one fast Bun process, with
622 **zero runtime dependencies** — the `package.json` dependency list is empty and
723 stays that way. Everything worth having is written here: the Result type, the
@@ -267,10 +283,9 @@ mechanical rather than advisory.
267283 `docs/PLANNING.md` is how issues depend on issues: the edge, the map, and
268284 what "ready now" means to a person and to the crew.
269285
270 `docs/STUDIO.md` is the forge with apps as the unit: tell, working, look,
271 shipped, asks you. It is the front door — a browser with no `forge_mode`
272 cookie lands there — and the switch to dev, in the top bar or `?mode=dev`
273 on any URL, is one click either way.
286 `docs/STUDIO.md` is the front door from the top of this page in full: the five
287 words and where each is decided, the box, what asks you, the three lists, a
288 tell, a run and a change each on its own page, and the board.
274289
275290 ## Develop
276291

↑↓ navigate ↵ open ⌘↵ its app esc close

Keyboard shortcuts

Docs