Skip to content

Build the docs with @pmndrs/docs@4 - #503

Open
abernier wants to merge 1 commit into
pmndrs:mainfrom
abernier:docs-v4
Open

Build the docs with @pmndrs/docs@4#503
abernier wants to merge 1 commit into
pmndrs:mainfrom
abernier:docs-v4

Conversation

@abernier

Copy link
Copy Markdown
Member

static.yml builds the docs by running ghcr.io/pmndrs/docs:2 inline. That image is no longer published — v4 of pmndrs/docs ships as an npm CLI instead — so this swaps the docker run for:

- run: npx -y @pmndrs/docs@4 build docs out --format website

Same environment variables, minus the three the CLI now derives itself:

  • MDX → the positional docs argument
  • OUTPUT / DIST_DIR → the positional out argument. BASE_PATH is still honoured, and the CLI copies the exported site to out, so upload-pages-artifact points at out instead of docs/out/xr/docs. The artifact keeps exactly the same layout, and bundle-artifacts / deploy are untouched.

The pnpm -r generate:docs step is kept — that is why this repo cannot simply call the reusable pmndrs/docs/.github/workflows/build.yml, which has no hook to run anything before the build.

Side effect worth having: from v3.2.0 the generator publishes /llms-full.txt, so once this lands https://pmndrs.github.io/xr/docs/llms-full.txt exists and the xr docs become readable by the pmndrs MCP server and the pmndrs-docs CLI, like drei, zustand and r3f already are.

🤖 Generated with Claude Code

https://claude.ai/code/session_0189fTPDjQHrqHxdaMkKCcEC

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