5b3f48a410
# Which Problems Are Solved Duplicate of https://github.com/zitadel/zitadel/pull/11405 - Users migrating from Actions V1 to V2 lack comprehensive documentation explaining the architectural differences and migration patterns - The existing migration guide doesn't provide enough context on why Actions changed and how to map V1 concepts to V2 - No clear reference table mapping common use cases to the appropriate V2 execution types # How the Problems Are Solved - Added a new comprehensive migration guide (`actions-v1-to-v2-migration.md`) covering: - Deprecation notice for Actions V1 (sunsetting in ZITADEL V5) - Architecture deep dive comparing V1 (embedded JavaScript) vs V2 (webhook model) - Key architectural differences table - Business benefits of migrating to V2 - Use case mapping table with links to ready-to-deploy Cloudflare Worker examples - Detailed flow explanations for Internal Authentication, External Authentication, Complement Token, and SAML Response customization --------- Co-authored-by: Rajat Singh <[email protected]>
ZITADEL-Docs
This website is built using Docusaurus 2, a modern static website generator.
The documentation is part of the ZITADEL monorepo and uses pnpm and Nx for development and build processes.
Quick Start
Run the following commands from the repositories root directory to install all dependencies needed. Using Corepack makes sure you have the pnpm version installed that is declared in .
corepack enable
pnpm install
Start a docs server
# Start development server with live-reloading
pnpm nx run @zitadel/docs:dev
# Or serve a production build
pnpm nx run @zitadel/docs:prod
The site will be available at http://localhost:3100
Add new Sites to existing Topics
To add a new site to the already existing structure simply save the md file into the corresponding folder and append the sites id int the file sidebars.js.
If you are introducing new APIs (gRPC), you need to add a new entry to docusaurus.config.js under the plugins section.
Build Process
The documentation build process automatically:
- Downloads required protoc plugins - Ensures
protoc-gen-connect-openapiis available - Generates gRPC documentation - Creates API docs from proto files
- Generates API documentation - Creates OpenAPI specification docs
- Copies configuration files - Includes configuration examples
- Builds the Docusaurus site - Generates the final static site