Fix follow-ups from PR #68 (rspress + Pages)#69
Merged
Conversation
Three issues found during review of the rspress docs PR. The content itself was clean (16 wiki pages renamed cleanly to docs/docs/wiki/, plus the rspress config and llms-full.txt plugin). These three needed follow-up: 1. Workflow trigger. The docs-build and docs-deploy jobs were added to release.yml, which is workflow_dispatch:-only. Their 'if: github.event_name == push' guards could therefore never fire, so Pages would never auto-deploy. Moved both jobs into a dedicated .github/workflows/docs.yml triggered by push to main (with pull_request:[docs/**] for PR validation). Pages permissions are declared at workflow scope; a concurrency group prevents overlapping deploys. Trimmed the dead jobs out of release.yml. 2. package-lock.json was out of sync — npm ci failed because transitive @emnapi/core was missing. Regenerated via `npm install --package-lock-only`. Verified `npm ci` + `npm run build` now succeed end-to-end. 3. Broken docs/wiki/ links in README.md (4) and AGENTS.md (1) — those paths moved to docs/docs/wiki/ under rspress's content root. Updated the live links so the GitHub file browser resolves them; CHANGELOG historical entries are left alone (immutable release record). Verified locally: - `cd docs && npm ci && npm run build` succeeds (1130.8 kB output, including llms-full.txt). - `uv run ruff check` clean. - `uv run pytest -q` → 327 passed (unchanged).
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.
Follow-ups to #68. The content move was clean; these three issues weren't blockers but need fixing before Pages can actually deploy.
1. Workflow trigger
The `docs-build` and `docs-deploy` jobs were added to `release.yml`, which is `workflow_dispatch:`-only. Their `if: github.event_name == 'push'` guards could therefore never fire, so Pages would never auto-deploy.
Moved both jobs into a dedicated `.github/workflows/docs.yml` triggered by:
Pages permissions (`pages: write`, `id-token: write`) are declared at workflow scope. A concurrency group named `pages` with `cancel-in-progress: true` prevents overlapping deploys. The dead jobs were trimmed out of `release.yml`.
2. `package-lock.json` out of sync
`npm ci` failed on the lock file shipped with #68 — missing transitive `@emnapi/core@1.10.0`. Regenerated via `npm install --package-lock-only`. Verified locally that `npm ci` + `npm run build` now succeed end-to-end (1130.8 kB output, including `llms-full.txt`).
3. Broken `docs/wiki/` links
The wiki content moved to `docs/docs/wiki/` under rspress's content root, so:
All fixed to `docs/docs/wiki/...`. CHANGELOG historical entries are left alone — they're an immutable release record.
Verification