Files
zitadel/docs
Mridang Agarwalla afa92e55f7 docs: added the updated docs for the new react example (#11073)
# Which Problems Are Solved

The React example needed updates to align with current best practices
and improve documentation clarity for developers integrating Zitadel
authentication.

# How the Problems Are Solved

Updated the React example codebase with improved authentication flow
using react-oidc-context, enhanced error handling and TypeScript type
safety, and refined component structure for better maintainability.

# Additional Changes

Updated documentation to reflect implementation details, added
comprehensive environment variable configuration examples with exact
variable names from the codebase, improved inline code comments, and
updated dependencies to latest stable versions.

# Additional Context

- Related to React integration example improvements
- Enhances developer experience when implementing Zitadel PKCE
authentication in React applications
2025-11-17 20:22:51 +00:00
..
2025-10-08 10:27:02 +02:00
2025-10-08 10:27:02 +02:00
2025-10-08 10:27:02 +02:00

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:start

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:

  1. Downloads required protoc plugins - Ensures protoc-gen-connect-openapi is available
  2. Generates gRPC documentation - Creates API docs from proto files
  3. Generates API documentation - Creates OpenAPI specification docs
  4. Copies configuration files - Includes configuration examples
  5. Builds the Docusaurus site - Generates the final static site