docs(readme): rewrite root README for developer onboarding - #17347
Merged
Conversation
Drop every count-based statistic (test badge, package/schema/file/line/token counts) and the sections that carried little value for a first-time reader (FDE pitch, full scripts table, standalone roadmap/architecture/contributing stubs). Lead with the five-minute loop, what one definition yields, why mistakes don't ship, MCP, shipping, and a single "hack on the framework" section. Refresh the facts the old copy had drifted from: the package directory now lists every published package and example in the workspace, the CLI list matches packages/cli/src/commands, the toolchain line matches packageManager, and the upgrade link points at the current docs page. Co-Authored-By: Claude Fable 5.1 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016gFSzdPX4324QMRKCjccTc
github-actions
Bot
added
size/m
documentation
os-sales
added
the
skip-changeset
Claude
This was referenced Sep 10, 2026
os-sales
marked this pull request as ready for review
September 10, 2026 10:35
os-sales
enabled auto-merge
September 10, 2026 10:35
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
2 participants
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.
Summary
Rewrites the root
README.mdwith three goals from the maintainer: remove every count-based statistic, delete low-value sections, and lead with what attracts a developer.Removed
Restructured into: hero → what's in this repo vs ObjectOS → five-minute loop → what one definition gives you (with the REST curl now targeting the same
support_desk_ticketobject the example defines) → why mistakes don't ship → MCP → ship it → hack on the framework (CLI, layers, collapsed package directory) → community → license.Facts refreshed against the tree
packages/plus all five examples (the old table listed roughly half;app-showcase, whichpnpm devruns, was missing).packages/cli/src/commands(addsverify,diff; points atos --helpfor the rest).packageManager); upgrade link points at the current/docs/upgradingpage instead of the 10→11 note.LICENSING.mdnext to the "no open-core asterisks" claim.Validation
node scripts/check-role-word.mjs— OKnode scripts/check-bash32-floor.mjs— OKcheck-doc-anchorsneedspnpm install(exit 3, prerequisite); the new README contains no#fragmentlinks, so it has nothing to judge here.Docs-only change; publishes nothing from any released package, so this PR carries no changeset (the
skip-changesetlabel applies).🤖 Generated with Claude Code
https://claude.ai/code/session_016gFSzdPX4324QMRKCjccTc
Generated by Claude Code