Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR migrates the documentation site from the Sphinx/RST build to a VitePress-based site (using @cakephp/docs-skeleton), and updates the container build to generate and serve the static site.
Changes:
- Replaces Sphinx
.rstdocs (and per-languageconf.py) with VitePress-ready Markdown files. - Adds VitePress configuration (sidebar TOC + theme export) and a docs-specific Node package setup.
- Replaces the previous docs build container approach with a multi-stage Docker build that runs
vitepress buildand serves via nginx.
Reviewed changes
Copilot reviewed 76 out of 78 changed files in this pull request and generated 9 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/package.json | Adds Node/VitePress tooling and dependencies for building docs. |
| docs/ja/view-helper.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/url-checkers.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/testing.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/password-hashers.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/migration-from-the-authcomponent.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/middleware.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/index.rst | Removes legacy Sphinx RST Japanese landing page (migration to VitePress). |
| docs/ja/identity-object.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/identifiers.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/ja/contents.rst | Removes Sphinx toctree index for Japanese docs. |
| docs/ja/conf.py | Removes Sphinx configuration for Japanese docs. |
| docs/ja/authentication-component.rst | Removes legacy Sphinx RST Japanese page (migration to VitePress). |
| docs/fr/view-helper.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/url-checkers.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/testing.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/password-hashers.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/middleware.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/index.rst | Removes legacy Sphinx RST French landing page (migration to VitePress). |
| docs/fr/identity-object.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/identifiers.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/fr/contents.rst | Removes Sphinx toctree index for French docs. |
| docs/fr/conf.py | Removes Sphinx configuration for French docs. |
| docs/fr/authentication-component.rst | Removes legacy Sphinx RST French page (migration to VitePress). |
| docs/es/password-hashers.rst | Removes legacy Sphinx RST Spanish page (migration to VitePress). |
| docs/es/middleware.rst | Removes legacy Sphinx RST Spanish page (migration to VitePress). |
| docs/es/index.rst | Removes legacy Sphinx RST Spanish landing page (migration to VitePress). |
| docs/es/identity-object.rst | Removes legacy Sphinx RST Spanish page (migration to VitePress). |
| docs/es/identifiers.rst | Removes legacy Sphinx RST Spanish page (migration to VitePress). |
| docs/es/contents.rst | Removes Sphinx toctree index for Spanish docs. |
| docs/es/conf.py | Removes Sphinx configuration for Spanish docs. |
| docs/es/authentication-component.rst | Removes legacy Sphinx RST Spanish page (migration to VitePress). |
| docs/en/view-helper.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/view-helper.md | Adds VitePress Markdown page replacing RST. |
| docs/en/url-checkers.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/url-checkers.md | Adds VitePress Markdown page replacing RST. |
| docs/en/upgrade-3-to-4.rst | Removes legacy Sphinx RST upgrade guide (replaced by Markdown). |
| docs/en/upgrade-3-to-4.md | Adds VitePress Markdown upgrade guide. |
| docs/en/upgrade-2-to-3.rst | Removes legacy Sphinx RST upgrade guide (replaced by Markdown). |
| docs/en/upgrade-2-to-3.md | Adds VitePress Markdown upgrade guide. |
| docs/en/testing.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/testing.md | Adds VitePress Markdown page replacing RST. |
| docs/en/redirect-validation.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/redirect-validation.md | Adds VitePress Markdown page replacing RST. |
| docs/en/password-hashers.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/password-hashers.md | Adds VitePress Markdown page replacing RST. |
| docs/en/migration-from-the-authcomponent.rst | Removes legacy Sphinx RST English page (replaced by sidebar/MD navigation). |
| docs/en/middleware.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/middleware.md | Adds VitePress Markdown page replacing RST. |
| docs/en/index.rst | Removes legacy Sphinx RST English landing page (replaced by Markdown). |
| docs/en/index.md | Adds VitePress Markdown landing page. |
| docs/en/impersonation.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/impersonation.md | Adds VitePress Markdown page replacing RST. |
| docs/en/identity-object.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/identity-object.md | Adds VitePress Markdown page replacing RST. |
| docs/en/identifiers.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/identifiers.md | Adds VitePress Markdown page replacing RST. |
| docs/en/contents.rst | Removes Sphinx toctree index (replaced by Markdown + VitePress sidebar). |
| docs/en/contents.md | Adds Markdown contents page consistent with VitePress navigation. |
| docs/en/conf.py | Removes Sphinx configuration for English docs. |
| docs/en/authentication-component.rst | Removes legacy Sphinx RST English page (replaced by Markdown). |
| docs/en/authentication-component.md | Adds VitePress Markdown page replacing RST. |
| docs/en/public/logo.svg | Adds VitePress public asset used by the docs site. |
| docs/en/public/icons/secure_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/icons/no_config_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/icons/mvc_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/icons/license_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/icons/build_quickly_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/icons/batteries_included_chiffon.svg | Adds VitePress public icon asset. |
| docs/en/public/favicon/web-app-manifest-192x192.png | Adds favicon/manifest image asset. |
| docs/en/public/favicon/site.webmanifest | Adds web app manifest for favicon setup. |
| docs/en/public/favicon/favicon.svg | Adds SVG favicon. |
| docs/en/public/favicon/favicon-96x96.png | Adds PNG favicon. |
| docs/en/public/favicon/apple-touch-icon.png | Adds Apple touch icon. |
| docs/config/all.py | Removes Sphinx global config (no longer used under VitePress). |
| docs/.vitepress/toc_en.json | Adds VitePress sidebar/table-of-contents configuration. |
| docs/.vitepress/theme/index.js | Adds VitePress theme entrypoint (docs-skeleton export). |
| docs/.vitepress/config.js | Adds VitePress site config (base URL, sidebar, nav, edit links). |
| docs/.gitignore | Adds docs-local ignore rules for Node/VitePress outputs. |
| docs.Dockerfile | Removes old Sphinx-based docs build Dockerfile. |
| Dockerfile | Updates container build to build VitePress docs and serve with nginx. |
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.
Member
|
Are we able to just merge? Or do we need to adjust sth on the servers? |
Contributor
Author
|
I included the Dockerfile from migrations but I think @LordSimal should check if it is enough to perform the deploy |
Member
|
ok, once @LordSimal merged, I can update the outdated docs. |
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.
Initial vitepress release