Repository navigation
docs(readme): a Website / Docs / Cloud / Discussions link row and one quick-start table the docs home links to - #30860
Merged
objectstack-fleet[bot] merged 2 commits intoNov 6, 2026
Conversation
… quick-start table the docs home links to The README opens with a plain link row under the badges, and a single "I want to... -> command" table covers scaffolding, the CLI with no project, the runtime image, shipping a scaffolded app, StackBlitz and working on the framework. The docs home's "Start here" list links to that table instead of carrying its own wording. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017ihL2ebbZkr2QAEG1x7UC8
Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_017ihL2ebbZkr2QAEG1x7UC8
Contributor
Author
|
domain:devx#2 · marchtian · session_017ihL2ebbZkr2QAEG1x7UC8 席位核对 — ACCEPT ·
|
objectstack-fleet
Bot
deleted the
claude/issue-30820-repo-first-impression
branch
November 6, 2026 07:44
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 田騏 · project thread
Fixes #30820
Clause-②: no
Metadata-protocol: none
维护者速读
README.md的## Quick start表(镜像那一行最长,需要三个环境变量);content/docs/index.mdx的 Start here 第一条。## For the maintainer对两项提案拍板(分支清理规则、根目录内部文件去留);本 PR 落地不依赖它,席位落地。What changes
README.md: a plain link row under the badges: Website · Docs · Cloud · Discussions. The badges are unchanged.PRODUCT_SITE_ORIGINinapps/docs/redirects.mjs(https://www.objectos.ai), the origin the docs nav's Product entry reads.https://objectstack.ai/docs).DEFAULT_CLOUD_URL(packages/cli/src/utils/cloud-config.ts,packages/cloud-connection/src/cloud-url.ts), the URL the runtime's unbound-host page names as the "ObjectOS Cloud console" (packages/cli/src/commands/serve.ts).has_discussionsis true on the repository.README.md: a new## Quick startsection, right after the intro, holds the one "I want to… → command" table: build a new app with an agent, run the platform with no project, run a compiled app in the official image, ship a scaffolded app, look on StackBlitz, work on the framework. The StackBlitz line that opened "Try it in five minutes" moved into the table.content/docs/index.mdx: the first "Start here" entry links to that table (https://github.com/objectstack-ai/objectstack#quick-start) instead of stating its own quick start.How each command was checked against the tree at
677d542a0e:npm create objectstack@latest my-app && cd my-app && npx os dev --uipackages/create-objectstack/package.json(namecreate-objectstack, bincreate-objectstack); the scaffolder installs dependencies unless--skip-install(src/index.ts);os devhas a--uiflag (packages/cli/src/commands/dev.ts); same commands as the README's own walkthrough and the docs landing's start boxnpm i -g @objectstack/cli && os startpackages/cli/package.jsonbinosandobjectstack;os startboots an empty kernel with the Console and marketplace when it finds no artifact and no config (packages/cli/src/commands/start.ts, itsdescription); default port 3000 (start.tsport flag text,serve.tsdefault)docker run … ghcr.io/objectstack-ai/objectstack:latestdocker/README.md"Or run it directly" (same mount path, same three variables it says to inject);docker/DockerfilepresetsOS_ARTIFACT_PATH=/srv/app/objectstack.jsonandOS_PORT=8080;latestis "quick starts only" in that README's tag table, and the row says to pinX.Y.Zin productiondocker build -t my-app . && docker compose up -dDockerfileanddocker-compose.yml(packages/create-objectstack/src/templates/blank/)Registry readings, 2026-11-06:
npm view create-objectstack version→18.3.0;npm view @objectstack/cli version bin→18.3.0, binsosandobjectstack; the anonymous ghcr tag list forobjectstack-ai/objectstackhas 49 tags,latestand18.3.0among them.For the maintainer
These are proposals. ⛔ Nothing below was executed: no branch was deleted and no file was moved.
Branches
Census at 2026-11-06 about 06:45Z. Heads from
git ls-remote --heads https://github.com/objectstack-ai/objectstack.git(1,591). Pull requests from RESTGET /repos/objectstack-ai/objectstack/pulls?state=open(41) and?state=closed, paged to the end (14,969), matching only same-repo heads byhead.ref. Each branch is counted once, in the first class that fits, in this order:mainchangeset-release/*changeset-release/main, the open Version Packages PRchangeset-release/mainclaude/*, 13copilot/*, 5deploy/*, 5jack/*, 2codex/*, 2gh-readonly-queue/*, andboard-archive,dev,kernel-change,feat/view-as-independent-entity,fix/sandbox-test-deadlinesFor the "other" class, tip ancestry was read against
b6182249c3in a full (not shallow) checkout, with control leggit merge-base --is-ancestor 61c079862a b6182249c3→ exit 0. 520 tips are already inmain, 127 are not, and 18 tips are not in the local object store. 368 have a tip already inmainand older than 30 days. 34 have a tip from the last 7 days: in-flight work before its PR opens, this card's own branch among them at census time.delete_branch_on_mergeis alreadytrueon the repository, and only 10 merged-PR branches from the last 30 days remain, so the merged backlog is mostly historical.Proposed rule, for the maintainer to run or delegate:
main,changeset-release/*,gh-readonly-queue/*(the merge queue owns these), any branch an open PR names, and any branch whose tip is younger than 14 days.mainand older than 30 days (368 today).main), so their owners can say whether they are still wanted.deploy/*,jack/*andboard-archivelook human-owned.Steps 2 to 4 would take the count from 1,591 to about 460. A report-only scheduled job that lists the candidates each week would keep it there; whether to add one is a separate decision.
Root files an evaluator sees
.claude/.claude/at the repository root onlyGOVERNED_SURFACES)AGENTS.md,CLAUDE.md.mcp.jsonchrome-devtools-mcp).vscode/mcp.json.vscode/at the workspace rootpaseo.jsonpnpm install,pnpm build)scripts/check-ci-filter-parity.mjsnames it)objectstack.code-workspace.plus../objectui../objectuipredatesui/living in this repository, so the second folder no longer exists for a fresh clonesdui.manifest.jsonscripts/gen-sdui-manifest-node.mjswrites it;ci.yml,lint.yml,release.ymlread it at the rootRELEASE_NOTES.mdcheck-links.yml,docs/releases-maintenance.md,content/docs/protocol/backward-compatibility.mdxdocs/, with those three links updated (one is a governed workflow)The ones an evaluator is most likely to read as internal are
paseo.json,.mcp.jsonandobjectstack.code-workspace. None of the three is needed by a user of the product, and none is governed. Deletingobjectstack.code-workspaceis the clearest win, since its second folder is gone.Tests
Docs and README only; no package code changed, so there is no unit test to add.
Acceptance notes
b6182249c3, thenpm i -g @objectstack/cli && os startwording the card attributes to the docs home is not incontent/docs/index.mdxor the docs landing (apps/docs/app/[lang]/page.tsx). The docs home had no quick start of its own; the landing's start box carriesnpm create objectstack@latest my-app/cd my-app/npx os dev --ui, the same commands as the table's first row. The deployed site may lag the tree.apps/docs/app/[lang]/page.tsxkeeps its own "Start here" box. Its commands match the table, so nothing contradicts it. Whether it should also link to the table is the seat's call.https://cloud.objectos.ai, the console. The docs landing's "ObjectOS Cloud" card goes tohttps://www.objectos.ai, the product site. If the maintainer wants the Cloud link to land on the product page instead, it is a one-word change.os start, or the image without Docker, is NOT MEASURED.package.jsonisprivateand no published package ships the rootREADME.mdorcontent/docs/, so this PR carriesskip-changeset.Verification
Head
23bcc39f49(mergesorigin/mainat677d542a0e).node scripts/pm/dispatch-gates.mjs --commands --repo objectstack-ai/objectstackderives 44 commands for the 2 changed paths; all 44 ran locally.Gates: 44 derived, 44 run, every exit 0
Two gates first exited 3 (prerequisite not met: a missing build). I built the named closure under the verify lock and reran:
pnpm check:docs-transcript-drift: exit 3, thenpnpm --filter '@objectstack/lint...' build(VERDICT command-exit 0), then exit 0pnpm --filter @objectstack/spec run check:skill-examples: exit 3, thenpnpm --filter '@objectstack/client-react...' build(VERDICT command-exit 0), then exit 0Final record:
--ranreconciliation:✓ dispatch-gates --ran: 44 derived famil(ies) accounted for — 44 run, 0 NOT-MEASURED (a DERIVED zero — all 44 recorded an exit code and none of them is 3).Lychee (
check-links.yml, offline) and Build Docs are CI's to run. The table's one file link,./docker/README.md, exists.pnpm check:doc-anchorschecked every README#fragmentthe table adds (#try-it-in-five-minutes,#ship-it,#hack-on-the-framework).🤖 Generated with Claude Code