Skip to content

docs: replace Hugo docs site with Vocs - #84

Merged
flexdinesh merged 1 commit into
mainfrom
docs-vocs
Oct 21, 2026
Merged

flexdinesh merged 1 commit into
mainfrom
docs-vocs

Conversation

@flexdinesh

Copy link
Copy Markdown
Owner
  • docs-website/: replace Hugo/Hextra (hugo.yaml, go.mod, content/) with Vocs 2 (vocs.config.ts, src/pages/*.md), renderStrategy: "full-static"; static output in dist/public/. Dead links fail the build.
  • React: docs pin react/react-dom ~19.3.1 directly (Vocs/Waku require 19.3); web app stays on catalog 19.2.8. vite uses the catalog. allowBuilds denies es5-ext and vue-demi scripts.
  • Content: port the 2 Hugo pages; add Usage, Reviewing changes, Piped diffs, Agent hooks and remote ingestion, API and data (from README), and Agent plugins, MCP, WebMCP (from docs/). Pages stay plain Markdown with relative page.md links, so GitHub renders them too.
  • Site is canonical for user docs: README trimmed to install, quick start, and absolute GitHub links to pages (README ships in release archives). docs/{mcp,plugins,webmcp}.md point to their site pages; docs/system.md and apps/web/PRODUCT.md repoint usage references.
  • mise: docs:dev/docs:build run the @diffx/docs pnpm scripts; hugo tool removed. Not added to check/CI.
  • Getting started: "Capture new changes" now describes Sync all checkouts (Alt+R) instead of restarting.

Validation: mise run docs:build (10 pages, no dead links); dev server smoke test (sidebar, search); mise run check passed. Pre-push passed on retry; the first attempt hit a plugin-pi subprocess timeout under load, and the package is untouched here.

Follow-up: hosting/deploy.

Port Hugo pages, add user guides from README and docs/, make the site
canonical for user docs, trim README to install, quick start and links.
Docs pin React 19.3 for Vocs; web app keeps catalog React.
@flexdinesh
flexdinesh marked this pull request as ready for review October 21, 2026 13:15
@flexdinesh
flexdinesh merged commit 43214ea into main Oct 21, 2026
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant