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

Browse Source

## 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]>

...

This commit is contained in:

Florian Forster

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

committed by GitHub

co-authored by Federico Coppede

parent 7b6395c348

commit d8ea041c56

2826 changed files with 78739 additions and 23571 deletions

Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL

Download Patch File Download Diff File Expand all files Collapse all files

apps/docs/public/img/actions-v2/console.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 37 KiB

apps/docs/public/img/actions-v2/local-listener.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 139 KiB

apps/docs/public/img/actions-v2/webhook-listener.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 139 KiB

apps/docs/public/img/actions-v2/webhook-url.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 35 KiB

apps/docs/public/img/actions-v2/webhook-xhr.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 63 KiB

apps/docs/public/img/angular/app-create.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 230 KiB

apps/docs/public/img/angular/app-screen.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 107 KiB

apps/docs/public/img/api/apis_overview.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 475 KiB

apps/docs/public/img/benchmark/Flowchart.svg

+1

File diff suppressed because one or more lines are too long

Side by Side After Width:  |  Height:  |  Size: 439 KiB

apps/docs/public/img/concepts/audit-trail/audit-log-events.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 410 KiB

apps/docs/public/img/concepts/audit-trail/event-viewer.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 446 KiB

apps/docs/public/img/concepts/features/domain-discovery.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 49 KiB

apps/docs/public/img/concepts/features/external-user-grant.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 234 KiB

apps/docs/public/img/concepts/features/identity-brokering.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 42 KiB

apps/docs/public/img/concepts/objects/instances.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 324 KiB

apps/docs/public/img/concepts/objects/object_overview.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.0 MiB

apps/docs/public/img/concepts/objects/organization.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 360 KiB

apps/docs/public/img/concepts/objects/organization_grants.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 324 KiB

apps/docs/public/img/concepts/usecase/saas.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.1 MiB

apps/docs/public/img/console_dashboard.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 455 KiB

apps/docs/public/img/console_feature_settings.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 308 KiB

apps/docs/public/img/console_instance_policy_general.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 224 KiB

apps/docs/public/img/console_instance_policy_notification.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 327 KiB

apps/docs/public/img/console_languages.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 208 KiB

apps/docs/public/img/console_login_texts.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 309 KiB

apps/docs/public/img/console_message_texts.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 295 KiB

apps/docs/public/img/console_org_identitiy_provider.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 3.7 MiB

apps/docs/public/img/console_org_identity_provider.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 3.3 MiB

apps/docs/public/img/console_org_manager_add.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 2.8 MiB

apps/docs/public/img/console_org_register.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 123 KiB

apps/docs/public/img/console_org_select.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 64 KiB

apps/docs/public/img/console_private_labeling.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 412 KiB

apps/docs/public/img/console_projects_add_new_roles.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 2.0 MiB

apps/docs/public/img/console_projects_application_token_settings.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 56 KiB

apps/docs/public/img/console_projects_empty.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 17 KiB

apps/docs/public/img/console_projects_granted.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 317 KiB

apps/docs/public/img/console_service_user_tokentype.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 169 KiB

apps/docs/public/img/console_serviceusers_create.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 1.7 MiB

apps/docs/public/img/console_serviceusers_new_key.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 4.1 MiB

apps/docs/public/img/console_serviceusers_secret.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 3.9 MiB

apps/docs/public/img/console_verify_domain.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 36 KiB

apps/docs/public/img/create-user.gif

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 3.6 MiB

apps/docs/public/img/deploy-to-vercel.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 280 KiB

apps/docs/public/img/develop2.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 14 KiB

apps/docs/public/img/device-auth/device-auth-01.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 276 KiB

apps/docs/public/img/device-auth/device-auth-02.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 334 KiB

apps/docs/public/img/device-auth/device-auth-03.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 253 KiB

apps/docs/public/img/device-auth/device-auth-04.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 181 KiB

apps/docs/public/img/device-auth/device-auth-05.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 229 KiB

apps/docs/public/img/device-auth/device-auth-06.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 353 KiB

apps/docs/public/img/device-auth/device-auth-07.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 55 KiB

apps/docs/public/img/device-auth/device-auth-08.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 43 KiB

apps/docs/public/img/device-auth/device-auth-09.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 50 KiB

apps/docs/public/img/device-auth/device-auth-10.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 82 KiB

apps/docs/public/img/device-auth/device-auth-11.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 50 KiB

apps/docs/public/img/django/app-auth-method.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 109 KiB

apps/docs/public/img/django/app-create.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 125 KiB

apps/docs/public/img/django/app-redirects.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 70 KiB

apps/docs/public/img/django/project-authorizations.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 35 KiB

apps/docs/public/img/django/project-roles.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 30 KiB

apps/docs/public/img/django/project-settings.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 64 KiB

apps/docs/public/img/docusaurus.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 5.0 KiB

apps/docs/public/img/examples/secure-api/app-jwt/1.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 310 KiB

apps/docs/public/img/examples/secure-api/app-jwt/10.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 345 KiB

apps/docs/public/img/examples/secure-api/app-jwt/11.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 347 KiB

apps/docs/public/img/examples/secure-api/app-jwt/2.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 627 KiB

apps/docs/public/img/examples/secure-api/app-jwt/3.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 382 KiB

apps/docs/public/img/examples/secure-api/app-jwt/4.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 270 KiB

apps/docs/public/img/examples/secure-api/app-jwt/5.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 353 KiB

apps/docs/public/img/examples/secure-api/app-jwt/6.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 295 KiB

apps/docs/public/img/examples/secure-api/app-jwt/7.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 330 KiB

apps/docs/public/img/examples/secure-api/app-jwt/8.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 356 KiB

apps/docs/public/img/examples/secure-api/app-jwt/9.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 333 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/1.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 275 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/2.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 193 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/3.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 184 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/4.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 293 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/5.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 294 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/6.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 321 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/7.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 346 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/8.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 310 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/9.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 516 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/1.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 348 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/2.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 218 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/3.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 355 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/4.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 228 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/5.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 257 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/6.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 260 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/7.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 248 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/8.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 273 KiB

apps/docs/public/img/examples/secure-api/service-user-jwt/scopes/9.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 247 KiB

apps/docs/public/img/flutter/authed.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 127 KiB

apps/docs/public/img/flutter/hello-world.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 64 KiB

apps/docs/public/img/flutter/nativeapp.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 248 KiB

apps/docs/public/img/flutter/not-authed.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 137 KiB

apps/docs/public/img/flutter/web-authed.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 122 KiB

apps/docs/public/img/flutter/web-not-authed.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 129 KiB

apps/docs/public/img/go/api-PAT_creation.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 53 KiB

apps/docs/public/img/go/api-PAT_view.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 136 KiB

apps/docs/public/img/go/api-app_details.png

BIN

Binary file not shown.

Side by Side After Width:  |  Height:  |  Size: 208 KiB

Some files were not shown because too many files have changed in this diff Show More