feat(docs): Docusaurus site scaffold + Pages CI (PR #1/3)#39
Open
EtienneLescot wants to merge 3 commits into
Open
feat(docs): Docusaurus site scaffold + Pages CI (PR #1/3)#39EtienneLescot wants to merge 3 commits into
EtienneLescot wants to merge 3 commits into
Conversation
First of three PRs for the docs site effort tracked in ROADMAP.md (tier 'Site & documentation', see PR #32). - website/: minimal Docusaurus 3 site (TS config, Infima-tweaked theme, hero landing with WIP badge, intro doc only). - .github/workflows/docs.yml: build on PR, deploy to GitHub Pages on push to main. Concurrency group, minimal permissions. - website/postcss.config.cjs: overrides the monorepo Tailwind config so Docusaurus CSS pipeline doesn't try to load Tailwind. PR #2 will polish the landing (full bento, demo, footer polish). PR #3 will migrate docs/ -> website/docs/.
Mechanical biome --write pass on the Docusaurus scaffolding files introduced in cce4524. No behavior change; resolves CodeRabbit formatting comments and unblocks the lint job.
Resolves the last remaining CodeRabbit review comment on PR #36. Pins actions/checkout, actions/setup-node, actions/upload-pages-artifact, and actions/deploy-pages to their current v4/v3 commit SHAs with inline version comments for grep-ability.
Collaborator
Author
|
@FabLrc previous PR was closed by error, so here is a new one |
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
1 participant
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.
Reintroduces the Docusaurus scaffold after PR #38 reverted the piggy-backed copy that landed via PR #36.
Three commits, in the order they were originally authored:
PR #2 will polish the landing (real screenshots, bento grid, animations, Geist font, search local).
PR #3 will migrate \\docs/\\ to \\website/docs/\.
How to validate locally
\\\\\sh
cd website
npm install
npm run typecheck
npm run build
npm run serve # http://localhost:3000/openscreen/
\\\\\
Deploy setup (one-time, in repo Settings)
Settings -> Pages -> Source = GitHub Actions. Until that's set, the deploy job will fail on \main\ push but the build job will pass and the PR preview artifact will be downloadable.