Skip to content

Refactor build to cake's new node based vitepress theme package#8262

Merged
LordSimal merged 2 commits into5.xfrom
refactor-vitepress-node-pkg
Mar 31, 2026
Merged

Refactor build to cake's new node based vitepress theme package#8262
LordSimal merged 2 commits into5.xfrom
refactor-vitepress-node-pkg

Conversation

@josbeir
Copy link
Copy Markdown
Contributor

@josbeir josbeir commented Mar 31, 2026

Migrates the docs build from a custom bash dev server to a proper Node.js package setup using @cakephp/docs-skeleton.

  • Add package.json with @cakephp/docs-skeleton and vitepress dependencies
  • Replace custom bin/dev-server.sh with standard npm run docs:dev
  • Move toc_*.json files into .vitepress, CI scripts into .github
  • Update workflow, README, and contributor docs to reflect new paths
npm install && npm run docs:dev

Notes:

  • When we merge this upwards to 5.next and 6.x keep an eye on refactored config file / toc locations which is now placed in the new .vitepress folder

Copilot AI review requested due to automatic review settings March 31, 2026 09:45
@josbeir josbeir force-pushed the refactor-vitepress-node-pkg branch 2 times, most recently from 164ba19 to 47953d0 Compare March 31, 2026 09:50
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.json and 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.

@josbeir josbeir force-pushed the refactor-vitepress-node-pkg branch from 47953d0 to 9ac860f Compare March 31, 2026 09:52
@josbeir josbeir force-pushed the refactor-vitepress-node-pkg branch from 9ac860f to 810325d Compare March 31, 2026 09:53
@LordSimal LordSimal merged commit 2397342 into 5.x Mar 31, 2026
6 checks passed
@LordSimal LordSimal deleted the refactor-vitepress-node-pkg branch March 31, 2026 16:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants