docs(releases,nav): v17 follow-up — Console gap backfill, sidebar restore, first docs sweep - #3908
Merged
Merged
Conversation
…tore, first docs sweep Three related closures on the just-merged v17 release page (#3906): 1. The Console section was missing 25 objectui commits. The v17 frontend window is cf2d56e32a11 → 4a4829d0ef39 = 128 commits, but the pending console-*.md changesets covered only 103: the range 2cb8d78e24ad...c6cfdf1288b6 landed with no changeset — exactly the "SHA bump leaves no trace" failure scripts/bump-objectui.sh exists to prevent. Two of the missing commits are breaking and each is the frontend half of a backend change the page already documented (useClientNotifications delegates ↔ #3612 SDK removal; @object-ui/types Capabilities re-exports ↔ the retired capabilities cluster). Both now sit beside their backend halves and in the upgrade checklist, with the other eight substantive commits folded into the Console section and .changeset/console-c6cfdf1288b6-backfill.md recording the range itself. 2. "releases" returns to the root sidebar. #3423 unlisted References and Releases together ("lookup content ... the docs home page links both"); that trade holds for References (22 generated pages) but not for Releases in a release window, when the upgrade notes are what people open the docs for. References stays out. check-release-notes now enforces what its success line already claimed: the section must be reachable via the root nav OR a /docs/releases link on the docs home — either satisfies it (preserving #3423's option), losing both fails the build. Negative-tested both directions. 3. First v17 docs sweep (docs/v17-docs-sweep.md — playbook + append-only run log with a watermark, built to re-run while the RC train iterates). Run 1 fixed the drift v17 left in hand-written prose: services-checklist (17→16 services, graphql rows, the dissolved ObjectStackProtocol), the anonymous-deny matrix still listing /graphql + handleGraphQL, sharing docs describing owner/group shapes as "declared but not enforced" (they no longer parse), http-protocol claiming enable.trash exists, REST/GraphQL in objectql diagrams/prose, and the objectstack-api skill description (mirrors regenerated via gen:skill-docs). False positives and out-of-scope findings (spec comment drift, implementation-status.mdx staleness) are logged for the next run. Verified: pnpm docs:build passes; check:release-notes / doc-authoring / role-word / org-identifier / nul-bytes / skill-docs-sync all green; the new guard branch fails when both entry points are removed and passes with either. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LXvaYR7TiJBCxYwjn51owH
|
The latest updates on your projects. Learn more about Vercel for GitHub. 1 Skipped Deployment
|
github-actions
Bot
added
documentation
30 tasks
…mp left stale The v17 RC version bump moved PROTOCOL_VERSION to 17.0.0 without re-running gen:spec-changes / gen:upgrade-guide, so spec-changes.json still declared protocolVersion 16.0.0 with no protocol-17 entries while the protocol-17 conversions were already registered and live. check:spec-changes (Check Generated Artifacts) fails on pristine origin/main — reproduced in a detached worktree — and surfaced here only because this PR is the first since the bump to touch a path the job's filter watches (skills/**). Mechanical regeneration, no hand edits: spec-changes.json gains the five protocol-17 conversions and protocolVersion 17.0.0; the upgrade guide gains its generated Protocol 16 → 17 section. All four job steps now pass locally (check:skill-docs, check:spec-changes, check:upgrade-guide, check:authorable-surface). Ships as a spec patch so npm consumers get the corrected manifest. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LXvaYR7TiJBCxYwjn51owH
Contributor
Author
|
已在 Generated by Claude Code |
Contributor
📓 Docs Drift CheckThis PR changes 1 package(s): 105 hand-written doc(s) reference the affected code and may need an implementation-accuracy re-verification:
|
The docs-drift-check bot on #3908 lists 105 spec-referencing docs and the docs-accuracy-audit workflow that re-verifies them. The fingerprint grep in this playbook targets removals; record the audit workflow (scoped via scripts/docs-audit/affected-docs.mjs) as the complementary deep pass to run once before changeset pre exit. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LXvaYR7TiJBCxYwjn51owH
os-zhuang
marked this pull request as ready for review
July 29, 2026 02:04
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.
#3906 的 follow-up,三件相关收尾:
1. Console 章节补上缺失的 25 个 objectui 提交
v17 前端窗口是
cf2d56e32a11(16.1.0 所 pin)→4a4829d0ef39= 128 个提交,但四条console-*.mdchangeset 只覆盖 103 个:2cb8d78e24ad...c6cfdf1288b6这段 bump 没有留下 changeset —— 正是bump-objectui.sh要防的「SHA bump leaves no trace」。缺口里有两条破坏性变更,且各自都是 #3906 页面上已写了后端半边的变更的前端半边:useClientNotifications删除死掉的 device/preference delegates(objectui#2862 ↔ 21 client SDK methods target routes no server surface mounts — delete on the open major train, or build the servers (#3587 finding) #3612 SDK 删除)@object-ui/types删除 Capabilities re-exports(objectui#2860 ↔ capabilities cluster 退役)两者现已并列在各自后端条目旁并进入升级 checklist;其余 8 条实质变更(effective-operation-set 门禁、approver record lookups、
{current_user_id}widget filters、org switcher 写入上下文、system-settings i18n、图片 click-to-zoom、导入邮箱校验、flow-node repeater 修复)并入 Console 章节;.changeset/console-c6cfdf1288b6-backfill.md追认该区间,历史不再有洞。2.
releases回到左侧根导航#3423 把 References 和 Releases 一起移出侧边栏(理由:「URL 可达 + 首页有链接」)。这个取舍对 References(22 页生成物)成立,但对发布窗口期的 Releases 不成立 —— 用户打开文档就是为了找升级说明。References 保持移出。
同时
check-release-notes补上它宣称但没查的那半:成功信息一直说 "navigable",实际只读 releases 段自己的meta.json,看不到整段从根导航消失。现在要求根导航或首页链接二选一可达(保留 #3423 的取舍空间),两者同时丢失才 fail。已做双向负向验证。3. 第一轮 v17 文档扫描(可重复)
新增
docs/v17-docs-sweep.md—— 扫描 playbook + 追加式运行日志,带 watermark(本轮:frameworka641d10· 305 changesets · objectui4a4829d0ef39),v17 还在迭代,后续按 watermark 增量重扫。Run 1 修复的漂移:kernel/services-checklist.mdxgraphql)、由已解散的ObjectStackProtocol治理permissions/authorization.mdx/graphql+handleGraphQL;owner-type 规则写成 "declared but seed-skipped"(现已不 parse)permissions/permissions-matrix.mdx/index.mdxprotocol/kernel/http-protocol.mdxenable.trash"exists as an object flag"(v17 已删)protocol/objectql/{index,schema}.mdx、permissions/field-level-security.mdxskills/objectstack-api/SKILL.mdgen:skill-docs再生成误报(
ai.requiresConfirmation是存活的 action 级键、ExecutionContext.tenantId是存活内部字段等)已记录在日志里,下轮免重判。范围外发现(spec 枚举注释仍写 "NLQ, Chat, Suggest, Insights"、implementation-status.mdx整页过期)已记录待办。验证
pnpm docs:build通过;check:release-notes/doc-authoring/role-word/org-identifier/nul-bytes/check:skill-docs(生成物同步)全绿@objectstack/consoleminor,主 changeset 为空(docs-only)🤖 Generated with Claude Code
https://claude.ai/code/session_01LXvaYR7TiJBCxYwjn51owH
Generated by Claude Code