Skip to content

docs(readme): slim the root README to a reader's page — contributor detail to CONTRIBUTING.md, stale lines out, ui/ named MIT - #26148

Merged
objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-b7nctw
Oct 26, 2026
Merged

objectstack-fleet[bot] merged 1 commit into
mainfrom
claude/project-thread-b7nctw

Conversation

@objectstack-fleet

Copy link
Copy Markdown
Contributor

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, 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

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

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>
@objectstack-fleet objectstack-fleet Bot added the skip-changeset PR has no user-facing published change; bypasses the changeset gate label Oct 26, 2026
@github-actions github-actions Bot added size/m documentation Improvements or additions to documentation labels Oct 26, 2026
@objectstack-fleet

Copy link
Copy Markdown
Contributor Author

席位核对 · ACCEPT · devx seat 2 · 2026-10-26T13:48Z

Seat domain:devx#2 (#20163) · session_01Q4MDXRbEJCNdPAP4SiXwp9 · reviewed head b650e87eea · card #26129, claim 6417105248, scope amendment 6417139067 (maintainer's ObjectOS three-edition ruling, 13:18Z).

  • Shape: draft → main, Fixes #26129, Clause-②: no, Metadata-protocol: none at line start. One commit.
  • Premise measured: P1–P5 hold on origin/main (README:435 "source lives in objectui", ROADMAP "Last updated: 2026-06-06", ui/LICENSE MIT with 0 ui/ lines in LICENSING.md, 2 figure refs, 464 lines).
  • Scope: exactly the three claimed files (+217/−237): README.md, CONTRIBUTING.md, LICENSING.md. None is governed; docs-only ⇒ skip-changeset is right.
  • Spot readings at the head:
  • Gates: 9/9 derived families exit 0, including check:doc-anchors (601 fragments), with 0 NOT-MEASURED. The dev's local link resolver reports 124 internal links, 0 bad, plus a negative control (report 6417558382). External links are NOT MEASURED from the container. CI was running at review; ready waits for every check green or skipped.
  • Accepted deviations:
    • D1: the 128-line package directory moved verbatim to CONTRIBUTING.md#package-directory, with a pointer left in README. Scope item 10 ("keep collapsed") and Acceptance line 1 (< 300) cannot both hold, since items 2–11 alone measured 397. The acceptance line wins, and the move is reversible.
    • D3: the "metadata-driven" paragraph was not in concepts/ontology. concepts/compare has a "Metadata-driven application platforms" section and is now linked, so the content still lives on the docs site.
    • D4: the ObjectOS wording in the Community line and LICENSING.md follows the same ruling as the amendment.
  • Out of scope: none filed.

Generated by Claude Code

@objectstack-fleet
objectstack-fleet Bot marked this pull request as ready for review October 26, 2026 13:51
@objectstack-fleet
objectstack-fleet Bot added this pull request to the merge queue Oct 26, 2026
Merged via the queue into main with commit 7d7879b Oct 26, 2026
45 checks passed
@objectstack-fleet
objectstack-fleet Bot deleted the claude/project-thread-b7nctw branch October 26, 2026 14:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation size/m skip-changeset PR has no user-facing published change; bypasses the changeset gate

Projects

None yet

2 participants