Build the docs with @pmndrs/docs@4 - #503
Open
abernier wants to merge 1 commit into
Open
Conversation
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.
static.ymlbuilds the docs by runningghcr.io/pmndrs/docs:2inline. That image is no longer published — v4 ofpmndrs/docsships as an npm CLI instead — so this swaps thedocker runfor:Same environment variables, minus the three the CLI now derives itself:
MDX→ the positionaldocsargumentOUTPUT/DIST_DIR→ the positionaloutargument.BASE_PATHis still honoured, and the CLI copies the exported site toout, soupload-pages-artifactpoints atoutinstead ofdocs/out/xr/docs. The artifact keeps exactly the same layout, andbundle-artifacts/deployare untouched.The
pnpm -r generate:docsstep is kept — that is why this repo cannot simply call the reusablepmndrs/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 landshttps://pmndrs.github.io/xr/docs/llms-full.txtexists and the xr docs become readable by the pmndrs MCP server and thepmndrs-docsCLI, like drei, zustand and r3f already are.🤖 Generated with Claude Code
https://claude.ai/code/session_0189fTPDjQHrqHxdaMkKCcEC