Livio SpringandGitHub
3afa6a2e81
# Which Problems Are Solved As part of the naming inconsistencies (#5888) we want to ensure action v1 flow name are always correct and mapping to enum values line up: #11309 # How the Problems Are Solved Rename last "Customize SAML Response" occurrences to "Complement SAML Response" where it's referring to the flow type. There are some titles left with "customize SAML / OIDC response", which refer to the intent of customizing the outcome and not directly to the flow type. # Additional Changes None # Additional Context - closes 11309
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