Skip to content

docs: vitepress conversion#778

Merged
LordSimal merged 3 commits into4.xfrom
vitepress-docs
Apr 2, 2026
Merged

docs: vitepress conversion#778
LordSimal merged 3 commits into4.xfrom
vitepress-docs

Conversation

@josbeir
Copy link
Copy Markdown
Contributor

@josbeir josbeir commented Mar 30, 2026

Initial vitepress release

image

Copilot AI review requested due to automatic review settings March 30, 2026 08:31
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 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 .rst docs (and per-language conf.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 build and 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.

@dereuromark
Copy link
Copy Markdown
Member

Are we able to just merge? Or do we need to adjust sth on the servers?

@josbeir
Copy link
Copy Markdown
Contributor Author

josbeir commented Mar 31, 2026

I included the Dockerfile from migrations but I think @LordSimal should check if it is enough to perform the deploy

@dereuromark
Copy link
Copy Markdown
Member

ok, once @LordSimal merged, I can update the outdated docs.

@LordSimal LordSimal merged commit e08b7a2 into 4.x Apr 2, 2026
8 checks passed
@LordSimal LordSimal deleted the vitepress-docs branch April 2, 2026 06:08
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.

4 participants