Files
zitadel/apps/docs/content/index.mdx
T
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

128 lines
3.9 KiB
Plaintext

---
title: ZITADEL Documentation
description: ZITADEL is the "Identity Infrastructure for developers". We provide a hardened and extensible turnkey solution to address all your authentication and authorization needs.
---
import { Card, Cards } from 'fumadocs-ui/components/card';
import { Rocket, Laptop, BookOpen, Book, Server, ShieldCheck, Terminal, MessageCircle, Calendar, Heart } from 'lucide-react';
**ZITADEL is the Identity Infrastructure for Developers.**
We provide a hardened, extensible turnkey solution for all your authentication and authorization needs. Instead of building your own login system, use ZITADEL to accelerate your project with features that work out of the box:
* **Secure Login**: Multi-factor authentication (OTP, U2F, Passkeys) and single sign-on (OIDC, SAML, OAuth2).
* **B2B Ready**: First-class multi-tenancy with branding customization and self-service.
* **Auditable**: Exhaustive audit trail of all events.
* **Extensible**: Execute custom code on events (Actions) to fit your unique workflows.
## Get Started
Explore our guides to get up and running with ZITADEL quickly.
<Cards>
<Card
title="Quick Start Guide"
href="/guides/start/quickstart"
icon={<Rocket />}
description="Learn how to set up ZITADEL in minutes."
/>
<Card
title="SDKs"
href="/sdk-examples/introduction"
icon={<Terminal />}
description="Explore our libraries for your favorite languages."
/>
<Card
title="Example Apps"
href="/examples/introduction"
icon={<Laptop />}
description="Sample applications to help you get started."
/>
</Cards>
## Deployment Options
You can use ZITADEL in two ways:
- **ZITADEL Cloud**: This is our public cloud service. Use the free tier to start in minutes.
- **Self-hosted ZITADEL**: For full control, deploy ZITADEL wherever you prefer.
If you're unsure, consider the generous free tier of [ZITADEL Cloud](/guides/manage/cloud/start).
<Cards>
<Card title="ZITADEL Cloud" href="/guides/manage/cloud/start" icon={<Server />}>
Choose if you want:
- A turnkey solution that's ready to go
- Global scalability without the hassle
- Data-residency compliance
</Card>
<Card title="Self-hosted" href="/self-hosting/deploy/overview" icon={<Server />}>
Choose if you want:
- Total control over all components
- Air-gapped or regulated environments
- Flexibility when deploying updates
</Card>
</Cards>
## Explore Components
Deep dive into the architecture and capabilities of ZITADEL.
<Cards>
<Card
title="Concepts"
href="/concepts"
icon={<BookOpen />}
description="Understand the core principles of ZITADEL."
/>
<Card
title="APIs"
href="/apis/introduction"
icon={<Laptop />}
description="Reference documentation for our REST and gRPC APIs."
/>
<Card
title="Self-hosting"
href="/self-hosting/deploy/overview"
icon={<Server />}
description="Learn how to deploy and manage ZITADEL yourself."
/>
<Card
title="Legal"
href="/legal"
icon={<ShieldCheck />}
description="Terms of service, privacy policy, and more."
/>
</Cards>
## Community & Support
Join the community and get help.
<Cards>
<Card
title="Discord"
href="https://zitadel.com/chat"
icon={<MessageCircle />}
description="Join our Discord chat to get help from the community and the ZITADEL team."
/>
<Card
title="Github Discussions"
href="https://github.com/zitadel/zitadel/discussions"
icon={<MessageCircle />}
description="Open a discussion on Github."
/>
<Card
title="Office Hours"
href="https://zitadel.com/office-hours"
icon={<Calendar />}
description="Join our bi-weekly community calls."
/>
<Card
title="Contribute"
href="https://github.com/zitadel/zitadel/blob/main/CONTRIBUTING.mdx"
icon={<Heart />}
description="Help us improve ZITADEL and its documentation."
/>
</Cards>