Gayathri VijayanandGitHub
d14d1df529
# Which Problems Are Solved The current documentation on setting up a MockSAML IDP is unclear/incomplete, and doesn't work with Login V2. # How the Problems Are Solved - Add a new section that explains mapping of MockSAML attributes to Zitadel user fields (using Actions V2) in case of Login V2 - Update the Actions V1 script used to prefill user data in case of Login V1 # Additional Changes N/A # Additional Context - Related to https://github.com/zitadel/zitadel/issues/11078
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 repositorys root directory to install all dependencies needed. Using Corepack makes sure you have the pnpm version intalled 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