Repository navigation
Commit 7d7879b
docs(readme): slim the root README to a reader's page — contributor detail to CONTRIBUTING.md, stale lines out, ui/ named MIT (#26148)
<!-- claude-projects-attribution: {"github_login":"os-steve"} -->
_Requested by **Steve** · [project
thread](https://claude.ai/code/project/chan_01FdL1XeUyvVNxLreh3F4Qi9?thread=cmsg_01FdL1XeUyvVNxLreh3F4Qi9VtPHVbfSWDg4vBhPwGkgzA)_
Fixes #26129
Clause-②: no
Metadata-protocol: none
## Summary
Root README slimmed from 464 to **277 lines** (`wc -l README.md`, head
`b650e87e`). Contributor detail moves to `CONTRIBUTING.md` verbatim; the
three stale lines go; one architecture figure stays; the ObjectOS line
and the licensing wording follow the scope amendment (comment
6417139067, the maintainer's edition ruling); `LICENSING.md` names `ui/`
as MIT. Docs-only: `skip-changeset`.
## Per scope item
1. First screen: quote block, tag line, GIF, "Try it in five minutes"
unchanged except the deletions below.
2. Quote block loses "Ontology-driven: database, API, UI and agent tools
all derive…" and "Apps small enough for AI to hold whole."; the
`architecture.png` block is deleted (file kept); `layers.png` stays; the
StackBlitz sentence now sits above step 1.
3. "What we mean by ontology" is one paragraph: the definition, what it
is not, links to `concepts/ontology` and `concepts/compare`. See
deviation 3 for the metadata-driven paragraph.
4. Capability table and `Ticket` block kept; both `curl` blocks and the
`client-react` sentence deleted.
5. The `find … | wc -l` command is replaced by the measured number:
**1,873 lines of TypeScript** (30 files under `examples/app-crm/src`,
`*.test.ts` excluded, at `95294be3`), measured with the README's own
command.
6. "You own it": everything needed to run an app is in this repository;
Cloud and Enterprise add hosting and multi-environment operations, Build
& Ask, SSO and support. The license sentence is byte-identical in README
and LICENSING.md: "Apache-2.0, except `ui/` (the Console and
`@object-ui/*`), which is MIT — both permissive" (`grep -cF` → README 2,
LICENSING.md 1).
7. "Hack on the framework": the six-line command block plus the one
sentence from the card, linking `CONTRIBUTING.md#build-and-test-cost`.
The `console:build` paragraph, the measured table and the `--affected`
paragraph moved verbatim to the new `CONTRIBUTING.md` section "Build and
Test Cost" (30 original lines, `count == 1` in CONTRIBUTING.md).
8. Three layers kept; "ObjectUI" links to `ui/`.
9. CLI table unchanged.
10. Console row now reads "Prebuilt Console SPA, version-locked to this
release; built from `ui/apps/console` in this repository" (in the moved
package directory, see deviation 1).
11. Community: `ROADMAP.md` link replaced by the North Star concept
page; a GitHub Discussions line added (`has_discussions: true` on the
repository).
Amendment, scope item 1: the ObjectOS sentence under the GIF now names
the three editions in one sentence with two links (objectos.ai and the
Ship-it section).
## Deviations (declared, for the seat's ruling)
1. **The package directory moved to
`CONTRIBUTING.md#package-directory`**, verbatim (still a collapsed
details block; the only changed row is item 10's Console row), and
README keeps a two-line pointer. Reason: with items 2–11 applied and the
directory left in place, README measured **397 lines**, and the
directory alone is 128 lines. Under 300 cannot be reached while it
stays. It is not on the Acceptance list of blocks that must stay in
README. If the seat wants it back, revert that one hunk: README goes
back to about 400 lines and Acceptance line 1 fails.
2. "Other examples: `pnpm dev:crm`, `pnpm dev:todo` …" moved with the
build section. The sentence "AGENTS.md is the working rulebook …;
CONTRIBUTING.md covers the workflow" was dropped, because
CONTRIBUTING.md already opens with that statement.
3. **Item 3's premise does not hold**: the metadata-driven paragraph is
not in `concepts/ontology`. `grep -rn 'previous generation\|names the
mechanism' content/` gives 0 hits. The closest text is
`concepts/compare` "Metadata-driven application platforms → The
difference", which the new paragraph links. The paragraph is deleted as
the card asks; `content/` is outside this card's file surface, so if its
wording should survive somewhere it needs a docs card.
4. Bounded in-place fixes, same class as the card (root-doc lines that
contradict the tree or the edition ruling), all inside the declared file
surface: the README Community ObjectOS line ("the commercial runtime" →
ObjectOS Cloud) and the LICENSING.md ObjectOS paragraph ("not part of
this repository" → Community is this repository; Cloud and Enterprise
are commercial). Without these two, the new first-screen sentence would
contradict them. Also: the README License section now uses the same
license sentence; CONTRIBUTING step 1 drops its `ROADMAP.md` pointer;
two CONTRIBUTING lines that pointed at the README's build table and
package directory now point inside CONTRIBUTING.
## Acceptance notes
- Out of scope, untouched: README line "target an ObjectStack Cloud
control plane" (#26136 carries it), `ui/README.md` (#26080), badge row,
organisation profile.
- External links: this container's egress gives no answer for
`objectstack.ai` / `objectos.ai` / shields (curl `000`), so they are NOT
MEASURED online. CI's `Check Links` runs lychee `--offline` (internal
links only). The two new external targets were checked from other
evidence: Discussions is enabled (repository API), and
`/docs/concepts/north-star` is `content/docs/concepts/north-star.mdx`,
listed in `concepts/meta.json`.
## Verification (head `b650e87e`)
- `wc -l README.md` → 277 (under 300).
- Links: a local resolver over README.md, CONTRIBUTING.md and
LICENSING.md checked 124 internal links and their `#fragments` with 0
bad. A control file with one missing file and one bad fragment made it
report 2 bad and exit 1.
- `node scripts/pm/dispatch-gates.mjs --commands --repo
objectstack-ai/objectstack` → 9 families, all exit 0:
`check-closing-keyword-parity` (scan and `--self-test`),
`check-comment-mask-corpus`, `check:doc-anchors` (601 fragment links
resolve; README.md is in its sources), `check:driver-memory-census`,
`check:gitlink-declared`, `check:nul-bytes`, `check:refd-timer-probe`,
`check:watch-hint-literal`. `--ran` reconciliation: 9 derived, 9 run, 0
NOT-MEASURED.
- No package or type-check surface touched; the type-check lanes are
left to CI.
---
_Generated by [Claude
Code](https://claude.ai/code/session_01RCk6dPzGgXCem5gzzuQJ61)_
Co-authored-by: Claude <noreply@anthropic.com>1 parent a9253a2 commit 7d7879b
3 files changed
Lines changed: 217 additions & 237 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
15 | 15 | | |
16 | 16 | | |
17 | 17 | | |
| 18 | + | |
18 | 19 | | |
19 | 20 | | |
| 21 | + | |
20 | 22 | | |
21 | 23 | | |
22 | 24 | | |
| |||
58 | 60 | | |
59 | 61 | | |
60 | 62 | | |
61 | | - | |
62 | | - | |
| 63 | + | |
| 64 | + | |
| 65 | + | |
| 66 | + | |
| 67 | + | |
| 68 | + | |
| 69 | + | |
| 70 | + | |
| 71 | + | |
| 72 | + | |
| 73 | + | |
| 74 | + | |
| 75 | + | |
| 76 | + | |
| 77 | + | |
| 78 | + | |
| 79 | + | |
| 80 | + | |
| 81 | + | |
| 82 | + | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
63 | 98 | | |
64 | 99 | | |
65 | 100 | | |
66 | 101 | | |
67 | 102 | | |
68 | 103 | | |
69 | | - | |
70 | | - | |
| 104 | + | |
71 | 105 | | |
72 | 106 | | |
73 | 107 | | |
| |||
105 | 139 | | |
106 | 140 | | |
107 | 141 | | |
108 | | - | |
| 142 | + | |
109 | 143 | | |
110 | 144 | | |
111 | 145 | | |
112 | | - | |
| 146 | + | |
113 | 147 | | |
114 | 148 | | |
115 | 149 | | |
116 | 150 | | |
117 | 151 | | |
| 152 | + | |
| 153 | + | |
| 154 | + | |
| 155 | + | |
| 156 | + | |
| 157 | + | |
| 158 | + | |
| 159 | + | |
| 160 | + | |
| 161 | + | |
| 162 | + | |
| 163 | + | |
| 164 | + | |
| 165 | + | |
| 166 | + | |
| 167 | + | |
| 168 | + | |
| 169 | + | |
| 170 | + | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
| 194 | + | |
| 195 | + | |
| 196 | + | |
| 197 | + | |
| 198 | + | |
| 199 | + | |
| 200 | + | |
| 201 | + | |
| 202 | + | |
| 203 | + | |
| 204 | + | |
| 205 | + | |
| 206 | + | |
| 207 | + | |
| 208 | + | |
| 209 | + | |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | + | |
| 214 | + | |
| 215 | + | |
| 216 | + | |
| 217 | + | |
| 218 | + | |
| 219 | + | |
| 220 | + | |
| 221 | + | |
| 222 | + | |
| 223 | + | |
| 224 | + | |
| 225 | + | |
| 226 | + | |
| 227 | + | |
| 228 | + | |
| 229 | + | |
| 230 | + | |
| 231 | + | |
| 232 | + | |
| 233 | + | |
| 234 | + | |
| 235 | + | |
| 236 | + | |
| 237 | + | |
| 238 | + | |
| 239 | + | |
| 240 | + | |
| 241 | + | |
| 242 | + | |
| 243 | + | |
| 244 | + | |
| 245 | + | |
| 246 | + | |
| 247 | + | |
| 248 | + | |
| 249 | + | |
| 250 | + | |
| 251 | + | |
| 252 | + | |
| 253 | + | |
| 254 | + | |
| 255 | + | |
| 256 | + | |
| 257 | + | |
| 258 | + | |
| 259 | + | |
| 260 | + | |
| 261 | + | |
| 262 | + | |
| 263 | + | |
| 264 | + | |
| 265 | + | |
| 266 | + | |
| 267 | + | |
| 268 | + | |
| 269 | + | |
| 270 | + | |
| 271 | + | |
| 272 | + | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
118 | 281 | | |
119 | 282 | | |
120 | 283 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
| 4 | + | |
| 5 | + | |
| 6 | + | |
4 | 7 | | |
5 | 8 | | |
6 | | - | |
7 | | - | |
8 | | - | |
| 9 | + | |
| 10 | + | |
| 11 | + | |
9 | 12 | | |
10 | 13 | | |
11 | 14 | | |
12 | | - | |
13 | | - | |
14 | | - | |
15 | | - | |
16 | | - | |
17 | | - | |
| 15 | + | |
| 16 | + | |
| 17 | + | |
| 18 | + | |
| 19 | + | |
| 20 | + | |
18 | 21 | | |
19 | | - | |
| 22 | + | |
| 23 | + | |
0 commit comments