Repository navigation
docs: edition layer — Editions group, three-path Start, editions badges, Reference summaries - #349
Merged
Merged
Conversation
…es, Reference summaries Every English page declares the ObjectOS editions it applies to (`editions:` frontmatter), rendered as a badge row under the title and a mark in the sidebar; type-check refuses an English page without it, through the same fumadocs-mdx loader the build validates with. A top-level Editions group (compare matrix, License & Pricing moved from Resources, Public Preview) and a Start group (Cloud, Community — the old Quickstart — and Enterprise) replace the single Quickstart entry, with permanent redirects for every moved URL. Extend Existing Systems moves under Build. The five framework-syntax Reference pages shrink to where ObjectOS uses the format plus a few examples, each linking its full specification on objectstack.ai, and docs.objectstack.ai links become objectstack.ai/docs. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QsR2jU9jZVmgYGkkQEtDwx
The mark sat inside each entry's link, so its screen-reader text became part of the link name: English product nouns inside a localized title, which the locale-surface gate refuses. The mark is now visual only (aria-hidden, names in a tooltip); the badge row under each title is the accessible statement of a page's editions. A group's mark also lines up with its pages' marks instead of floating mid-row. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QsR2jU9jZVmgYGkkQEtDwx
type-check now ends with scripts/check-frontmatter.mjs, which fails any English page without a valid editions: key; the Commands line quoted the old three-step command. Co-Authored-By: Claude <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01QsR2jU9jZVmgYGkkQEtDwx
Contributor
Author
维护者速读
席位意见: 建议批准。矩阵里的价格、AI、支持各格都出自现有 License 页,存储 1 GB / 20 GB、Free 无开发环境、MCP 限额、自有域名、RLS/FLS 出自卡片原文。其余格子写 n/d,等 cloud 侧确认后另卡补齐(本项目读不到 cloud 仓)。#348 也改 AGENTS.md,两者位置不同;席位一次只落一个,等前一个上线冒烟通过再落下一个。 席位核对 · ACCEPT · 2026-10-27T13:48Z ·
|
os-zhuang
approved these changes
Oct 27, 2026
os-zhuang
marked this pull request as ready for review
October 27, 2026 14:09
This was referenced Oct 27, 2026
This was referenced Oct 27, 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 Steedos · project thread
Fixes #343
Clause-②: no
Metadata-protocol: none
维护者速读
/docs/quickstart、/docs/resources/license、/docs/extend-existing-systems)靠永久重定向承接,已在本地 workerd 预览实测落到新页;type-check从此在英文页缺editions:时变红,写新页的人会被拦。回滚即 revert 本 PR,无数据或协议面。apps/docs/source.config.ts的 schema 函数(英文页必须带editions:,译文页豁免);②apps/docs/scripts/check-frontmatter.mjs(fumadocs-mdx CLI 本身不校验 frontmatter,所以加了这一步,带活体反例自检);③content/docs/editions/compare.mdx的矩阵(无来源的格子写 n/d,未猜)。/docs/configure/runtime,应看到标题下“Available in: Community · Enterprise”两枚徽章,左侧栏该页右侧有两个小图标;访问/docs/quickstart应跳到 “Run ObjectOS Community locally”。AGENTS.md新增的一行规则(受管面);批准后由席位落地。What changes
Editions group (top level, after Architecture)
editions/compare.mdx— the matrix, columns Community / Cloud Free / Cloud Team / Enterprise. Every cell is a fact the card states or one this repository already states with a source; the rest read n/d with a legend, and are listed under open questions below.resources/license.mdx→editions/license.mdx(rename, redirect).editions/public-preview.mdx— data durable, APIs may change, no SLA yet.Start group (replaces Quickstart)
start/cloud.mdx— sign up, organization and slug, production environment, first app (AI Builder or template), invite members.quickstart.mdx→start/community.mdx, retitled "Run ObjectOS Community locally", intro rewritten (rename, redirect).start/enterprise.mdx— points into Deploy.editions:on every English pagecommunity,cloud,enterprise(apps/docs/lib/editions.ts). Required on English pages, optional on*.<locale>.mdx.components/editions.tsx, linking to Compare Editions in the route's locale) and as an icon mark in the sidebar and mobile drawer (app/[lang]/docs/layout.tsx). A group whose pages share one non-all set is marked once on the group. The mark isaria-hidden; the badge row is the accessible statement.[community, enterprise]; Configureruntime,data-sources,storageare[community, enterprise]; the rest of Configure is all three, as the card says. Beyond the card:reference/environment-variablesis[community, enterprise]andbuild/ai-builderis[cloud, enterprise](both follow from pages this repository already has). Tally: 64 all three, 15 community+enterprise, 2 cloud, 1 cloud+enterprise, 1 community, 1 enterprise (84 English pages).type-checknow fails on an English page without the key:next typegen && fumadocs-mdx && tsc --noEmit && node scripts/check-frontmatter.mjs.Reference
rest-api,objectql,cel,field-types,skills-clishrink to where ObjectOS uses the format plus examples. Each opens with the same first line:**Full specification:** [… on objectstack.ai](…). This page is the summary: where ObjectOS uses it, and a few examples.Anchors other pages link to are kept; code samples kept are byte-identical.environment-variables,cli,security,runtime-capabilitiesunchanged.AGENTS.md: one rule line in the Don't list (no syntax tables; link the specification).Moves and links
extend-existing-systems.mdx→build/extend-existing-systems.mdx(rename, redirect).docs.objectstack.ailink now points toobjectstack.ai/docs/...; each target page and anchor checked against the objectstack repository'scontent/docs.field-types,objectql,skills-cli) are deleted in all locales;gen-zh-hantremoved the zh-Hant copies. No*.<locale>.mdxwas edited.ui-text: one new key,editionsLabel("Available in"), with values in the six locale JSONs (precedent: the app-chrome keys of earlier PRs);zh-Hant.jsonregenerated.Tests
type-checkis the enforcement. Measured before the keys were added: 80 of 214 pages failed it. The check carries a live negative control: it writes a temporary English page withouteditions:and exits 1 as NOT MEASURED if that page validates. Probes also confirmed an unknown value, a duplicate and an empty list are refused, and a locale file without the key passes.smoke-docs.mjs: the/docs/quickstarttarget is now a redirect assertion, landing on/docs/start/communitywith H1 "Run ObjectOS Community locally".Acceptance notes
apps/docs/next.config.mjs. The card namesapps/docs/redirects.mjs, which is the objectstack repository's file; here themovedtable innext.config.mjsis where every redirect already lives..github/scripts/smoke-docs.mjs(its quickstart target would otherwise fail post-deploy) andREADME.md(two License links to the new URL).type-checkas three steps; it is left for the maintainer so this PR adds exactly one governed line.meta.<l>.jsonfiles are untouched (English only): locale sidebars still listlicenseunder Resources and do not yet listextend-existing-systemsunder Build, until the translation pass. The pages themselves resolve.start/cloud.mdx; Business SSO details.Verification
All of ci.yml's steps, run locally in the foreground at
7c399fb, exit codes captured before any pipe.Gates — all exit 0
gen-zh-hant --checkcheck-doc-samplestype-checkbuildcheck-locale-surfacecheck-positioningcheck-search-localesturbo testcheck-translationscheck-translation-ownershipsmoke-docs.mjson the workerd previewBrowser check (Playwright, 1440 and 390)
/ja/docs/editions/compare)./docs/quickstart,/docs/resources/license,/docs/extend-existing-systemsand/ja/docs/quickstarteach land on the new page with 200.Line budget
130 files changed, +1051 / −4536. The Reference summaries are −4443 of that (
content/docs/reference/**, 30 files including the deleted locale siblings).🤖 Generated with Claude Code
https://claude.ai/code/session_01QsR2jU9jZVmgYGkkQEtDwx