feat(docs): Docusaurus site scaffold + Pages CI (PR #1/3)#31
Closed
EtienneLescot wants to merge 1 commit into
Closed
feat(docs): Docusaurus site scaffold + Pages CI (PR #1/3)#31EtienneLescot wants to merge 1 commit into
EtienneLescot wants to merge 1 commit into
Conversation
Collaborator
Author
|
PR #1/3 ready for review. CI build green (artifact github-pages uploaded). One manual step before merge — Settings → Pages → Source = \GitHub Actions. The deploy job is gated on push to \main, so without that toggle the first post-merge run will fail with a clear error. Fix is one click. What's in this PR:
Follow-ups:
|
7b09b8b to
0950787
Compare
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/.
0950787 to
cce4524
Compare
Collaborator
Author
Collaborator
Author
|
Closing as superseded — every commit in this branch is already on \main:
Rebased onto \origin/main\ (\ix/pr-31-rebase) → 0 diff. Nothing left to merge. PRs #2 and #3 in the docs-site tier can continue from the merged state on \main. |
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.
What this PR does
Scaffolds the OpenScreen docs site (Docusaurus 3, monorepo under \website/) and adds a GitHub Pages deployment workflow. First of three PRs planned in the ROADMAP tier Stability & quality → Site & documentation (see PR #32).
What's intentionally NOT in this PR
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)
Before the deploy job actually ships:
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.