andwati/zitadel

Fork 0

mirror of https://github.com/andwati/zitadel.git synced 2026-10-18 13:52:51 +00:00

Files

T

History

d8ea041c56 docs: introduce versioned docs and migrate to fuma (#11166 )

## Todos for release

- [x] Configure Env in docs project on vercel
- [x] Configure Root Path in the docs project on vercel
- [ ] Remove old CSP https://github.com/zitadel/website/pull/1592

## What we did

This pull request migrates the project documentation from the old
`docs/` directory to the new `apps/docs/` directory, introduces a new
documentation system built with Next.js and Fumadocs, and updates all
relevant references, configuration files, and documentation to reflect
this change. It also adds new configuration and ignore files for the new
documentation app, updates CI and linting to exclude the new docs from
certain checks, and revises the contributing guidelines accordingly.

**Documentation System Migration and New Docs App**

* Migrated all documentation from `docs/` to `apps/docs/`, and updated
all references in `README.md`, `CONTRIBUTING.md`, and other files to
point to the new location.
[[1]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L585-L640)
[[2]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L660-R607)
[[3]](diffhunk://#diff-eca12c0a30e25b4b46522ebf89465a03ba72a03f540796c979137931d8f92055L740-R687)
[[4]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L2-R3)
[[5]](diffhunk://#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L30-R30)
* Added a new Next.js/Fumadocs-based documentation app under
`apps/docs/`, including core app files, layouts, routing, search API,
and a comprehensive `README.md` with development and contribution
instructions.
[[1]](diffhunk://#diff-5a1b07344a2c1b4d3f37b23ff1388b62cd9f57dea3c1cd23d8a0412b7602b132R1-R74)
[[2]](diffhunk://#diff-462b9ad1eabbb7d1c29bb9c36e4931eb180fd7190900e6d2babf8f4d66ad1c28R1-R39)
[[3]](diffhunk://#diff-e16ae25660ded787b10ac35dea96d5ecaacf895dae0afc8a9bd4382dc79a8c87R1-R7)
[apps/docs/app/[[...slug]]/layout.tsxR1-R81](diffhunk://#diff-59e08acde4e805b7aeccef1dcf98f1d71dfc550777e6b9402085cee0e9fa4e0aR1-R81),
[apps/docs/app/[[...slug]]/page.tsxR1-R79](diffhunk://#diff-e5df3f80d0fa01e12d63d81f29c57a9d14e846c78fd3beabb2ef768e38fd9580R1-R79),
[[4]](diffhunk://#diff-389b34918e040cacaa87cd7201ffa462cc2b0b716736f537e3d3c660ac69353bR1-R7)
[[5]](diffhunk://#diff-d3b03416d1c457b19f1c27b26f2db741412df841b875c26ccadc36e4522247f4R1-R29)
[[6]](diffhunk://#diff-c8fb8339570a5305809be7c618e14705fd86390dc278e6ce8ba224a7bc8b0c3cR1-R25)

**Configuration and Tooling Updates**

* Updated `.github/workflows/codeql.yml`, `.golangci.yaml`, and
`.github/dependabot.yml` to properly handle the new docs app: excluded
`apps/docs` from certain checks, added npm dependency updates for the
docs app, and excluded generated content.
[[1]](diffhunk://#diff-12783128521e452af0cfac94b99b8d250413c516ec71fe6d97dbea666ff7ba27L8-R14)
[[2]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R5-R6)
[[3]](diffhunk://#diff-9917ddc9f1c3304218f7269265b746d997c5c0615478177b5fceecd33ef47cb5R126-R129)
[[4]](diffhunk://#diff-dd4fbda47e51f1e35defb9275a9cd9c212ecde0b870cba89ddaaae65c5f3cd28R89-R106)
* Updated `.devcontainer/devcontainer.json` to use the latest Go 1.25.3
version for consistency.

**Licensing and Miscellaneous**

* Added `apps/docs/` to the list of licensed directories in
`LICENSING.md`.

These changes ensure the documentation is now maintained in a modern,
scalable system and all project tooling is updated to support the new
structure.

---------

Co-authored-by: Federico Coppede <[email protected]>

2026-01-29 08:38:36 -08:00

src

docs: introduce versioned docs and migrate to fuma (#11166 )

2026-01-29 08:38:36 -08:00

.editorconfig

feat(console): integrate frontend (#95 )

2020-05-13 14:41:43 +02:00

.env.dev

chore: rehaul DevX (#10571 )

2025-10-08 10:27:02 +02:00

.eslintrc.js

fix(console): update eslint, redirect user without roles, private labeling save and icon (#4459 )

2022-09-29 05:25:57 +00:00

.prettierignore

chore(e2e): formatting with prettier (#4385 )

2022-09-19 19:49:46 +02:00

.prettierrc

fix(console): use authService for auth user page (#5233 )

2023-02-27 12:03:44 +01:00

angular.json

feat(i18n): add Arabic language support (#11161 )

2026-01-22 17:07:47 +01:00

buf.gen.yaml

fix: use versioned openapi protoc plugin for docs and console (#11423 )

2026-01-26 13:20:46 +01:00

karma.conf.js

feat(console): integrate frontend (#95 )

2020-05-13 14:41:43 +02:00

ngsw-config.json

fix: update assets in ngsw-config.json (#1027 )

2020-11-27 16:32:14 +01:00

package.json

fix(console): remove rehauled navigation #10863 (#10912 )

2026-01-16 08:30:09 +01:00

prebuild.development.js

chore(dev): fix fetching http env json (#5921 )

2023-05-24 13:07:55 +00:00

project.json

fix: improve NX caching (#11434 )

2026-01-29 14:42:52 +01:00

README.md

chore: management console naming inconsistency (#11390 )

2026-01-26 14:52:15 +00:00

tsconfig.app.json

chore(console): Angular 20 #10690 (#10768 )

2025-10-08 07:10:50 +00:00

tsconfig.json

chore(console): Angular 20 #10690 (#10768 )

2025-10-08 07:10:50 +00:00

tsconfig.spec.json

chore(console): dependency update (#5653 )

2023-04-18 15:42:29 +02:00

README.md

Zitadel Management Console

The Management Console is Zitadels management UI.

It is built using Angular and part of the Zitadel monorepo.

To get started follow the contributing quick start.

Building

To build for production:

pnpm nx run @zitadel/console:build

This will:

Generate proto files (via prebuild script)
Build the Angular app with production optimizations

Linting

To run linting and formatting checks:

pnpm nx @zitadel/console:lint

To auto-fix formatting issues:

pnpm nx @zitadel/console:lint-fix

Project Structure

src/app/proto/generated/ - Generated proto files (Angular-specific format)
buf.gen.yaml - Local proto generation configuration
project.json - Nx orchestration and caching for builds and tests
prebuild.development.js - Development environment configuration script

Dependency Chain

The Management Console app has the following build dependencies managed by Nx:

@zitadel/proto:generate - Generates the protobuf stubs
@zitadel/client:build - Builds the TypeScript gRPC client library
@zitadel/console:generate - Generates Management Console-specific protobuf stubs
@zitadel/console:build - Creates a production build from Management Console

This ensures that the Management Console always has access to the latest client library and protobuf definitions.

Proto Generation Details

@zitadel/proto generation: Modern ES modules with @bufbuild/protobuf for v2 APIs
Local buf.gen.yaml generation: Traditional protobuf JavaScript classes for v1 APIs

The Management Console app calls Zitadel v1 and v2 APIs. As long as the Management Console still calls v1 APIs, it needs to import client stubs from separate sources:

Source outputs from direct buf generation for v1 APIs
@zitadel/client for v2 APIs

Legacy v1 API (Traditional Protobuf)

Uses local buf.gen.yaml configuration
Generates traditional Google protobuf JavaScript classes extending jspb.Message
Uses plugins: protocolbuffers/js, grpc/web, grpc-ecosystem/openapiv2
Output: src/app/proto/generated/
Used for: Most existing Management Console functionality

Modern v2 API (ES Modules)

Uses @zitadel/proto package generation
Generates modern ES modules with @bufbuild/protobuf
Uses plugin: @bufbuild/es with ES modules and JSON types
Output: login/packages/zitadel-proto/
Used for: New user v2 API and services

Dependency Management

The Management Console's project.json ensures proper execution order:

@zitadel/proto:generate runs first (modern ES modules)
Management Console's local generation runs second (traditional protobuf)
Build/lint/start tasks depend on both generations being complete

This approach allows the Management Console app to use both v1 and v2 APIs while maintaining proper build dependencies.

Legacy Information

This project was originally generated with Angular CLI version 8.3.20 and has been updated over time.