Repository navigation
chore(docs): upgrade vocs to 2.x - #347
Merged
Merged
Conversation
There was a problem hiding this comment.
🔵 Needs a closer look
The Vocs/Waku migration changes Vercel’s output layout and Markdown routing, but no deployment has been validated, so deployed pages, navigation, assets, and .md URLs still need human verification.
No open issues 🎉
What changed in this PR
Migrates the private documentation site to Vocs 2, adapting configuration, demos, and deployment for its new static-build architecture without changing published package code.
Changes:
- Updates Vocs dependencies, configuration, component APIs, and stylesheet loading.
- Preserves wallet-demo styling and dark-mode behavior, and marks the discovery demo as a client component.
- Updates Vercel output and Markdown routing, removes obsolete dependency overrides, and restricts CI token permissions.
| File | Description |
|---|---|
vercel.json |
Deploys the new static output and rewrites Markdown URLs. |
pnpm-workspace.yaml |
Removes obsolete security overrides while retaining the TOML override. |
docs/vocs.config.ts |
Adopts Vocs 2 configuration and full-static rendering. |
docs/sidebar.ts |
Updates the sidebar type to use the new configuration API. |
docs/pages/wallet-standard.mdx |
Migrates the Callout import and variant prop. |
docs/pages/_root.css |
Loads Tailwind through the automatic root stylesheet. |
docs/package.json |
Upgrades Vocs and supporting dependencies; updates the build command. |
docs/components/wallet-modal-ui.tsx |
Adds stylesheet ordering and dark-theme synchronization. |
docs/components/wallet-discovery.tsx |
Declares the discovery demo as a client component. |
docs/components/layer-order.css |
Defines CSS layer precedence to preserve modal styling. |
.gitignore |
Ignores generated Vercel artifacts. |
.github/workflows/pr.yml |
Limits workflow token permissions to read-only repository contents. |
Review effort: Balanced
vocs 2 is a rewrite on Waku (React Server Components) with Vite 8 and built-in Tailwind. - vocs ^2.12.0 with its waku / vite peers; react ~19.3.1 - config: import from `vocs/config`, keep pages in `docs/pages` (`srcDir: "."`), `renderStrategy: "full-static"`; Tailwind plugin is built in, so `@tailwindcss/vite` and the `vite` option are gone - `styles.css` -> `pages/_root.css`; `Callout` from `vocs` with `variant` - `"use client"` on the discovery demo - UI demo: declare the cascade layer order before the hoisted get-starknet-ui stylesheet, and mirror the vocs theme onto a `dark` class, so the modal keeps its styles and dark mode - Vercel: static output is now `docs/dist/public`; rewrite `/<page>.md` to `/assets/md/<page>.md` for the llms.txt links - drop the `@hono/node-server` and katex overrides (vocs 2 resolves a fixed `@hono/node-server` in range and no longer pulls mermaid); keep toml, still ^3 via remark-mdx-frontmatter Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Fixes code scanning alert actions/missing-workflow-permissions. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
adrienlacombe
force-pushed
the
claude/docs-vocs-2
branch
from
October 29, 2026 19:05
5fb2b52 to
80e7354
Compare
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.
Migrates the private docs site from vocs 1.4.1 to vocs 2.12.0, and fixes code scanning alert #1.
vocs 2 is a rewrite on Waku (React Server Components) with Vite 8 and built-in Tailwind. The content and sidebar didn't need changes; the work was config, styling and deployment.
Changes in
docs/vocs ^2.12.0, with itswaku 1.0.0-rc.4/vite ^8.3.5peers. React moves to~19.3.1, which vocs 2 requires and which the workspace already resolved to.@tailwindcss/viteis removed because vocs 2 bundles Tailwind.vocs.config.ts: imports fromvocs/config.srcDir: "."keeps the pages indocs/pages(no file moves).renderStrategy: "full-static"builds a pure static site. Theviteplugin option is gone.styles.cssmoves topages/_root.css, the file vocs 2 loads automatically.Calloutis now imported fromvocsand takesvariantinstead oftype. The discovery demo gets"use client".wallet-modal-ui.tsx):WalletConnectModallost its styling. React hoists theget-starknet-uistylesheet above vocs's stylesheet, and because it declares theutilitieslayer first, vocs's reset layer (vocs_base) ends up after it and wins.components/layer-order.cssdeclares the full layer order before both.<html class="dark">, which vocs 1 set and vocs 2 doesn't (it only setscolor-scheme). A small hook mirrors the vocs theme onto the class while the demo is mounted.Changes outside
docs/vercel.json:docs/dist/public, Waku's layout.llms.txtlinks to per-page Markdown (/<page>.md). Those files are emitted at/assets/md/<page>.md, and vocs's Vercel adapter adds no route for them infull-staticmode, so a rewrite maps one to the other..gitignore: adds.vercel. WhenVERCELis set, vocs also writesdocs/.vercel/output. Vercel ignores it because the project root is the repo root, sooutputDirectoryis what gets deployed.pnpm-workspace.yamloverrides:@hono/node-server: removed. vocs 2 asks for^2.0.2and resolves 2.1.5 in range.katex: removed. mermaid is only an optional peer of vocs 2 and the docs don't use it, so mermaid and katex leave the tree. That drops 110 lockfile entries, including dompurify and marked.toml: kept. vocs 2 still pulls it at^3throughremark-mdx-frontmatter@^5.2.0..github/workflows/pr.yml: addspermissions: contents: read(code scanning alert choose a wallet/wallets discovery popup #1,actions/missing-workflow-permissions). The job only checks out, installs, builds and tests.Verification
pnpm install --frozen-lockfile,format:check,build,typecheck,lint:checkandtest(50 tests) all pass.tsc --noEmitondocs/is clean.pnpm auditreports 0 advisories across all 1,226 dependencies. As a sanity check, it does flag zod 4.4.3 and toml 3.0.0 in a scratch project.llms.txtandllms-full.txtare present, plus new404.htmland Waku's internal_root.d/. AVERCEL=1build still fillsdocs/dist/public.vocs preview, 1366px wide):/getting-started.mdreturnstext/markdown.Not verified / behaviour changes
outputDirectoryand the.mdrewrite are only checked locally (the rewrite pattern against path-to-regexp 6). Please check the first production deploy.llms.txtformat: now in sidebar order, linking to.mdpages without descriptions (vocs 2's format).🤖 Generated with Claude Code