mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 05:52:51 +00:00
Florian ForsterandGitHub
238d98bb30
# Which Problems Are Solved - `@zitadel/docs:generate-proto-docs` could block while `npx` waited for confirmation to install `@bufbuild/buf`. - When the docs generation ran through `nx run-many --target generate`, that interactive prompt was hidden, so the task appeared stuck without visible output. # How the Problems Are Solved - Resolve Buf from the workspace root with `pnpm exec buf generate` so the repo-pinned CLI is used non-interactively. - Run the Buf command from the workspace context instead of the temporary execution directory. - Keep the existing generation arguments, template handling, and excluded path handling intact. # Additional Changes - Remove the temporary directory setup that was only needed for the previous `npx`-based invocation. - Keep the existing `protoc-gen-connect-openapi` installation and PATH wiring unchanged. # Additional Context - Follow-up for the docs generation issue discussed in Discord where `@zitadel/docs:generate-proto-docs` prompted for `@bufbuild/buf` installation and appeared blocked under `nx run-many --target generate`. - Validated with `pnpm nx run @zitadel/docs:generate-proto-docs --outputStyle=stream`. - Validated with `pnpm nx run @zitadel/docs:generate --outputStyle=stream`.
@zitadel/docs
Documentation for Zitadel, built with Fumadocs and Next.js.
Getting Started
Ensure you have followed the root quick start to set up dependencies.
Local Development
Start the development server:
pnpm nx run @zitadel/docs:dev
The site will be available at http://localhost:3000.
Scripts
Key scripts for documentation workflows:
| Script | Description |
|---|---|
dev |
Starts the development server. |
build |
Builds the production application. |
fetch:remote-content |
Fetches remote tags and referenced content. |
generate |
Runs all generation steps (fetch:remote-content, generate:proto-docs, generate:api-reference, generate:index-pages). |
check:links |
Validates content integrity (broken links, missing frontmatter, schema errors). |
check-types |
Validates typescript types. |
test |
Runs all validation steps (check-types, check:links). |
lint |
checks for code style and syntax errors (ESLint). |
clean |
Cleans the build output and generated files. |
Validation
- Code Quality: Run
pnpm lintto check for syntax and style issues in JS/TS/MDX files. - Content Integrity: Run
pnpm check:linksto validate content structure, including:- Broken internal links
- Missing required front-matter (e.g.,
title) - Image references
Contributing
Build Process
The docs build process automatically handling the following steps via generate:
- Downloads required protoc plugins.
- Generates gRPC documentation from proto files.
- Generates API documentation from OpenAPI specs.
- Generates index files for directory structures.
Style Guide
- Variables: Use environment variables in code snippets where possible.
- Embedded Content: Use
_filename.mdxfor content embedded in other pages (not indexed individually). - Code Embedding: Use the
fileproperty in code blocks to embed code from the repo. - Voice: Use active voice and sentence case for titles.
Refer to the Google Developer Style Guide for general guidelines.
Adding Content
All documentation content is located in the content directory. Note that the system strictly accepts only .mdx files.
To add a new page:
- Create a
.mdxfile in the appropriate subdirectory ofcontent. - Register the new page in the sidebar settings at
lib/sidebar-data.tsto make it accessible in the navigation.
Pull Requests
Use docs(<scope>): <short summary> for PR titles.
Pass quality checks before submitting:
pnpm nx run @zitadel/docs:build
pnpm nx run @zitadel/docs:check:links
You can also run specific steps individually:
pnpm fetch:remote-contentpnpm generate:api-reference