Introduce VitePress documentation using @cakephp/docs-skeleton#1055
Introduce VitePress documentation using @cakephp/docs-skeleton#1055
Conversation
There was a problem hiding this comment.
Pull request overview
This PR migrates the CakePHP Migrations plugin documentation from Sphinx/RST to VitePress/Markdown, powered by a shared @cakephp/docs-skeleton theme package. The old RST files, Python config, and Docker-based docs builder are removed in favor of a Node.js-based VitePress setup.
Changes:
- Converts all documentation from RST to Markdown format, adds a new
upgrading.mdguide, and removes the old Sphinx configuration - Introduces VitePress configuration with CakePHP branding via
@cakephp/docs-skeleton, including sidebar TOC, version picker, and theme setup - Removes the old
docs.Dockerfilefor Sphinx-based builds
Reviewed changes
Copilot reviewed 21 out of 23 changed files in this pull request and generated 10 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/package.json | New npm package with VitePress and docs-skeleton dependencies |
| docs/.vitepress/config.js | VitePress config with project-specific overrides |
| docs/.vitepress/theme/index.js | Re-exports CakePHP theme |
| docs/.vitepress/toc_en.json | Sidebar navigation structure |
| docs/en/*.md (new) | Markdown versions of all documentation pages |
| docs/en/*.rst (deleted) | Removed old RST documentation files |
| docs/en/conf.py, docs/config/ (deleted) | Removed Sphinx configuration |
| docs/en/contents.md | Table of contents in markdown |
| docs/en/upgrading.md | New 4.x→5.x upgrade guide |
| docs/.vitepress/cache/deps/* | Build cache artifacts (should not be committed) |
| docs/.gitignore | Git ignore for node_modules and public |
| docs.Dockerfile | Removed old Sphinx Docker build |
Files not reviewed (1)
- docs/package-lock.json: Language not supported
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
|
I already did a - comparably small - conversion in cakephp/chronos#510 which was fairly easy. Had to drop the dokku app and re-create it though as there was some weird branch config present. |
Document the --style anonymous option for bake migration including: - Benefits of anonymous migration classes - Command usage example - Generated code structure - Global Migrations.style configuration option
|
anything left? or can we merge? then we can add more docs. |
|
i will try to tackle this on the weekend. |
Use shorthand npm package syntax
Think this can now be deployed :-) @LordSimal as you are the dokku-god, i'll let that honor fall on you :-) |
Adds VitePress-based documentation for this project, powered by the new distributable CakePHP configured VitePress theme
@cakephp/docs-skeletonthat provides CakePHP branding, shared assets, and sensible defaults out of the box.The skeleton follows VitePress's official distributable theme pattern, so the setup here is minimal:
@cakephp/docs-skeleton/configwith project-specific overridesvitepress dev/build/previewcommands — no custom wrappers or env varsnpm updateBefore i address the other versions i want to make sure that we have 5.x handled properly.
@LordSimal it would be great if you could introduce a dokku dockerfile to deploy this one? I removed the docs.Dockerfile from this branch but it can be introduced again using the same naming if needed.
Additionally, (also) after this is done we should swap the main doc repo's to the new node based plugin first as it is a lot easier to maintain like this.