Refactor build to cake's new node based vitepress theme package#8262
Merged
Refactor build to cake's new node based vitepress theme package#8262
Conversation
164ba19 to
47953d0
Compare
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation tooling from a custom bash-based dev server to a Node.js/VitePress package setup built around @cakephp/docs-skeleton, aligning local development and CI with the upstream skeleton’s theme/config approach.
Changes:
- Adds
package.json/package-lock.jsonand VitePress npm scripts for dev/build/preview. - Moves TOC files into
.vitepress/and introduces a new.vitepress/config.js+ theme entrypoint. - Relocates CI helper scripts into
.github/and updates docs/CI references accordingly.
Reviewed changes
Copilot reviewed 9 out of 16 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Updates local development instructions to use npm/VitePress scripts. |
| package.json | Introduces Node package setup and VitePress scripts/dependencies. |
| package-lock.json | Locks dependency tree for reproducible installs. |
| docs/en/contributing/documentation.md | Updates contributor commands to new .github/ script paths. |
| config.js | Updates TOC loading paths to .vitepress/. |
| bin/dev-server.sh | Removes the old bash orchestration dev server. |
| .vitepress/toc_en.json | Adds TOC under .vitepress/ for English sidebar. |
| .vitepress/toc_ja.json | Adds TOC under .vitepress/ for Japanese sidebar. |
| .vitepress/theme/index.js | Switches theme to @cakephp/docs-skeleton. |
| .vitepress/config.js | Adds VitePress config extending the skeleton base config. |
| .gitignore | Ignores newly introduced public asset paths. |
| .github/workflows/docs-validation.yml | Updates CI to call the relocated .github/* validation scripts. |
| .github/check-toc-links.js | Adds TOC link validation script under .github/. |
| .github/check-links.js | Adds internal markdown link checker under .github/. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
47953d0 to
9ac860f
Compare
9ac860f to
810325d
Compare
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.
Migrates the docs build from a custom bash dev server to a proper Node.js package setup using
@cakephp/docs-skeleton.@cakephp/docs-skeletonandvitepressdependenciesbin/dev-server.shwith standardnpm run docs:devtoc_*.jsonfiles into .vitepress, CI scripts into .githubnpm install && npm run docs:devNotes: