740669a4bd
# Which Problems Are Solved Some features moved from Beta to GA in V4, are still labeled as beta in the docs and APIs refer to the now deprecated beta endpoints. # How the Problems Are Solved - remove the beta labels from webkeys, login v2, actions v2 - change example calls and API reference to v2 (instead of v2beta) # Additional Changes fixed typo in the web keys title (Oauth2 -> OAuth2) # Additional Context - Organization service v2(beta) is solved in https://github.com/zitadel/zitadel/pull/11207 - relates to #10772 --------- Co-authored-by: Gayathri Vijayan <[email protected]> Co-authored-by: Copilot <[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