Repository navigation
chore: upgrade vocs to 2.12.0 - #1070
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
LGTM. This swaps the vocs preview pin for the npm 2.11.0 release, and the config and docs are updated to match.
What was reviewed:
- package.json, the pnpm-workspace override and patchedDependencies, and the lockfile importer, package and snapshot entries all point at vocs@ 2.11.0. The patch was renamed with its content unchanged, so the patch hash is the same. Nothing in the repo still refers to vocs@ 2.10.3 or pkg.pr.new/vocs.
- The version-scoped
vocs@ 2.11.0entry in minimumReleaseAgeExclude works on the pinned pnpm 10.28.1. The lockfile still resolves @ pierre/highlights@ 0.2.0, so dropping its exclusion depends only on it being older than 24h. - The lockfile can't show whether the patch applies cleanly to the 2.11.0 tarball. CI's frozen-lockfile install and build will confirm that.
Extended reasoning...
This is a dependency version bump. It touches package.json, pnpm-workspace.yaml, pnpm-lock.yaml, a renamed patch file with unchanged content, and two docs files. It touches no security-sensitive code: no auth, crypto or data handling. The edits are mechanical and consistent across the manifest, the workspace overrides and patch mapping, and the lockfile, with no stale references left behind. There is no CODEOWNERS file and no reviewer objection open.
brendanjryan
changed the title
There was a problem hiding this comment.
I reviewed the latest push and didn't find any bugs. The PR changed a lot after the first review, though: it now targets vocs 2.12.0 with a rebased 719-line patch, not 2.11.0 with the patch left unchanged, so a human look is still worthwhile. The title and description still describe the 2.11.0 plan and should be updated.
What was reviewed:
package.json, thevocsoverride,minimumReleaseAgeExclude,patchedDependenciesand the lockfile all use 2.12.0, and the lockfile's patch_hash points atpatches/vocs@ 2.12.0.patch.- The
vocs.config.tssidebar renames (introduction: false,groupItems,tagGroupItems) and the one-argumentuseActiveSidebarAnchor(links)call inDocsSidebarDrawer.tsxassume these now ship in upstream Vocs. The rebased patch no longer adds them, and I couldn't check the 2.12.0 tarball here.
Extended reasoning...
This is a docs-site dependency upgrade. It swaps a commit-pinned Vocs preview for the npm 2.12.0 release, replaces a 1522-line local patch with a 719-line rebased one covering src and dist, renames the OpenAPI sidebar config options and updates one hook call. It touches no auth, crypto or data-handling code. I deferred for three reasons: the patch to a third-party package is large and was rewritten after the first review; the new option names and hook signature depend on the upstream 2.12.0 API, which I couldn't inspect here; and the PR description no longer matches the code.
Upgrades the docs site from vocs 2.11.0 to the published vocs 2.12.0 and moves the API reference sidebar onto the OpenAPI options 2.12.0 adds upstream, so the local patch shrinks from 1,522 to 719 lines.
Removed
introFlat,hide,groupExtrasByName,sectionExtras: hunks indist/internal/openapi/{openapi.d.ts,registry.js,sidebar.d.ts,sidebar.js}). Upstream in wevm/vocs#682.vocs.config.tsnow usesintroduction: false(wasintroFlat: true),groupItems(wasgroupExtrasByName),tagGroupItems(wassectionExtras);hide: ['MCP']keeps its name.useActiveSidebarAnchorhook files, itsindexexports, and theSidebar.js/Sidebar.tsxhunks includingaria-current). Upstream in wevm/vocs#678, which exportsuseActiveSidebarAnchorfromvocs. The upstream hook takes onlylinksand reads path and hash from the router, soDocsSidebarDrawer.tsxcallsuseActiveSidebarAnchor(links)and no longer importsuseRouter.Kept (and why)
patches/vocs@2.12.0.patch(re-created from the remaining 2.11.0 hunks, applies to the 2.12.0 tarball with no fuzz;patch -R --dry-runconfirms none are already upstream): playground query presets (query-presets,OpenApiPage,Playground.client,PlaygroundStandalone),Head/LayoutincludeTitle, theRoothead change, and theNotFoundtitle and noindex. None of these are in the 2.12.0 changelog.vocsoverride (now2.12.0): keepstapimo's transitive vocs on the patched release.minimumReleaseAgeExclude:vocs@2.11.0→vocs@2.12.0(published today, inside the release-age window).@braintree/sanitize-url,dayjs,wakupatches,guard-vocs-config.mjs: unrelated to the 2.12.0 changes. The site still registers Mermaid pages, so wevm/vocs#679 (Mermaid bundled only where used) doesn't remove the ESM patches.Verification
/docs/apisidebar (registry.build+registry.sidebarsagainst the live spec) with 2.11.0+old patch+old options, and again with 2.12.0+new patch+new options. The JSON is byte-identical. The builtdist/public/docs/api/index.htmlsidebar shows the same top level: API reference (no generated Introduction), Accounts, Earn API, Routes API, Zones API, Data API, Console, MPP, Routes Access Requests, Zone Delegations. MCP stays hidden.pnpm install: installsvocs@2.12.0with the patch applied.biome check .: clean. Typecheck (tsgoontsconfig.app.jsonandtsconfig.node.json,--singleThreaded): pass.pnpm build:site(afterguard-vocs-config.mjs): pass, 691 files generated.pnpm check:markdown: pass (0 findings, 335 pages, 9 sections).vitest run --dir src: 77/77 files, 1562/1562 tests passed.