Repository navigation
docs(readme): slim the root README to a reader's page — contributor detail to CONTRIBUTING.md, stale lines out, ui/ named MIT - #26148
Merged
Conversation
Contributor detail (build-cost table, --affected path, console:build explanation, the package directory) moves verbatim to CONTRIBUTING.md; the stale Console-source and ROADMAP lines go; one architecture figure; the ObjectOS edition line and the Apache-2.0 / MIT (ui/) licensing wording follow the maintainer's edition ruling, and LICENSING.md names ui/ as MIT with the same wording. Claude-Session: https://claude.ai/code/session_01RCk6dPzGgXCem5gzzuQJ61 Co-authored-by: Claude <noreply@anthropic.com>
Contributor
Author
席位核对 · ACCEPT · devx seat 2 · 2026-10-26T13:48ZSeat
Generated by Claude Code |
This was referenced Oct 26, 2026
This was referenced Oct 26, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Requested by Steve · project thread
Fixes #26129
Clause-②: no
Metadata-protocol: none
Summary
Root README slimmed from 464 to 277 lines (
wc -l README.md, headb650e87e). Contributor detail moves toCONTRIBUTING.mdverbatim; 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.mdnamesui/as MIT. Docs-only:skip-changeset.Per scope item
architecture.pngblock is deleted (file kept);layers.pngstays; the StackBlitz sentence now sits above step 1.concepts/ontologyandconcepts/compare. See deviation 3 for the metadata-driven paragraph.Ticketblock kept; bothcurlblocks and theclient-reactsentence deleted.find … | wc -lcommand is replaced by the measured number: 1,873 lines of TypeScript (30 files underexamples/app-crm/src,*.test.tsexcluded, at95294be3), measured with the README's own command.ui/(the Console and@object-ui/*), which is MIT — both permissive" (grep -cF→ README 2, LICENSING.md 1).CONTRIBUTING.md#build-and-test-cost. Theconsole:buildparagraph, the measured table and the--affectedparagraph moved verbatim to the newCONTRIBUTING.mdsection "Build and Test Cost" (30 original lines,count == 1in CONTRIBUTING.md).ui/.ui/apps/consolein this repository" (in the moved package directory, see deviation 1).ROADMAP.mdlink replaced by the North Star concept page; a GitHub Discussions line added (has_discussions: trueon 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)
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.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.concepts/ontology.grep -rn 'previous generation\|names the mechanism' content/gives 0 hits. The closest text isconcepts/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.ROADMAP.mdpointer; two CONTRIBUTING lines that pointed at the README's build table and package directory now point inside CONTRIBUTING.Acceptance notes
ui/README.md([Decision] ui/ merge leftovers that no aftercare card names: six nested top-level docs, a second copy of four .claude hooks, an independently numbered ui/docs/adr, and a dead ui/.github/dependabot.yml #26080), badge row, organisation profile.objectstack.ai/objectos.ai/ shields (curl000), so they are NOT MEASURED online. CI'sCheck Linksruns lychee--offline(internal links only). The two new external targets were checked from other evidence: Discussions is enabled (repository API), and/docs/concepts/north-stariscontent/docs/concepts/north-star.mdx, listed inconcepts/meta.json.Verification (head
b650e87e)wc -l README.md→ 277 (under 300).#fragmentswith 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.--ranreconciliation: 9 derived, 9 run, 0 NOT-MEASURED.Generated by Claude Code