96f9bbc044
docs: structure update ( #11275 )
...
### **Restructure Docs Navigation & Consolidate Core Concepts**
**Summary**
This PR refactors the documentation navigation to follow a clearer
**User Journey** and consolidates fragmented pages to reduce redundancy.
**Key Changes**
* **Sidebar:**
* Replaced the legacy resource-based structure with user-journey-focused
categories.
**Proposed Structure:**
```
Get Started
├─ Overview
│ └─ Guides Overview (Brief intro to docs, persona-aligned: "Get auth working in minutes for your B2B app.")
├─ Quickstart Guide
│ └─ Quickstart (Step-by-step: Sign up, spin up instance, connect app, log in – mirrors brand's 4-step guide.)
├─ Authenticate Users
│ ├─ Login with ZITADEL (OIDC)
│ ├─ Get ID / Access Token
│ └─ Logout
├─ Examples & SDKs
│ ├─ SPA / Frontend
│ ├─ Web Applications
│ ├─ APIs / Backend Services
│ ├─ Hybrid / Full-Stack
│ └─ Sample Applications (Include community-contributed examples for openness.)
├─ Key Concepts
│ ├─ Instances, Orgs, Projects, Apps
│ ├─ Policies (Intro)
│ └─ Users & Roles
└─ Use Cases
├─ B2B Integration (Tailored to multi-tenant enterprise needs.)
├─ B2C Login
├─ Multi-Tenant / SaaS
├─ Branded Login & White-Label
└─ Machine-to-Machine (M2M)
Configure Identity & Policies
├─ Identity Providers
│ ├─ External IDPs (e.g., Google, Azure)
│ └─ Custom Providers
├─ Policies
│ ├─ Password Policies
│ ├─ Lockout Policies
│ └─ Privacy Policies
├─ Roles & Permissions
│ ├─ RBAC Setup
│ └─ Custom Roles
└─ Compliance & Security
├─ Audits & Logs
└─ Certifications (Highlight trust through openness.)
Integrate & Authenticate
├─ OIDC & OAuth Flows
├─ API Access
│ ├─ gRPC APIs
│ └─ REST APIs
├─ SDKs
│ ├─ Go
│ ├─ JavaScript/TypeScript
│ ├─ Python
│ └─ Others (Link to community SDKs.)
└─ External Integrations
├─ SAML
├─ LDAP
└─ Webhooks
Test & Debug
├─ Testing Tools
│ ├─ Console Testing
│ └─ API Playground
├─ Common Issues
│ ├─ Token Errors
│ └─ Integration Failures
└─ Debugging Guides
├─ Logs & Monitoring
└─ Error Codes Reference
Deploy & Operate
├─ Deployment Options
│ ├─ Cloud (ZITADEL Cloud)
│ ├─ Self-Hosted (Linux, MacOS)
│ ├─ Docker Compose
│ └─ Kubernetes
├─ Configuration
│ ├─ Environment Variables
│ └─ Advanced Settings
├─ Scaling & Performance
│ ├─ High Availability
│ └─ Backup & Restore
└─ Monitoring & Maintenance
├─ Metrics
└─ Upgrades
Architecture & Concepts
├─ System Architecture
│ ├─ Core Components
│ └─ Data Flow Diagrams (Expressive visuals per brand.)
├─ Principles
│ ├─ Multi-Tenancy
│ └─ Open Standards (OIDC, SAML)
└─ Advanced Topics
├─ Customization
└─ Extensibility (Open-source contributions.)
Product, Releases & Support
├─ Product Features
│ ├─ Roadmap (Public, for transparency.)
│ └─ Pricing & Tiers
├─ Releases
│ ├─ Changelog
│ └─ Upgrade Guides
└─ Support Resources
├─ Community (Discord, GitHub – for community-led growth.)
├─ FAQ
├─ Contact Support
└─ Contribute (Encourage feedback/shaping the product.)
```
**Content Consolidation:**
* Merged separate "Concept" and "Console Guide" files into single,
comprehensive **Overview** pages for core resources:
* `Organizations`, `Projects`, `Applications`, `Users`, `Console`, and
`Actions`.
```
concepts/structure/organizations + guides/manage/console/organizations -> guides/manage/console/organizations-overview
concepts/structure/projects + guides/manage/console/projects -> guides/manage/console/projects-overview
concepts/structure/applications + guides/manage/console/applications -> guides/manage/console/applications-overview
concepts/structure/users + guides/manage/console/users -> guides/manage/console/users-overview
guides/manage/console/actions + apis/actions/introduction -> guides/manage/console/actions-overview
concepts/features/console + guides/manage/console/overview -> guides/manage/console/console-overview
```
**Redirects (`vercel.json`):**
* Added permanent redirects for all the 6 legacy files mentioned above
**No files were deleted**
---------
Co-authored-by: Florian Forster <[email protected]
2026-01-09 15:07:02 -03:00
Federico Coppede and GitHub
8a0580b358
docs: fix deprecated label for actions v2 ( #11242 )
...
Removed deprecated label for Action V2 endpoints and removed Beta label
also. Fixed actions V2 domain endpoint (v2 instead of v2beta)
2025-12-29 17:26:49 +01:00
Federico Coppede and GitHub
941c446443
docs: remove typos ( #11240 )
...
removed typos from the doc pages
Fixes : #11234
2025-12-29 13:51:03 +00:00
Federico Coppede and GitHub
03916cd0f2
docs: create guide for generic OIDC IDP ( #11233 )
...
Fixes #7191
2025-12-26 15:40:21 -03:00
Federico Coppede and GitHub
15e89078da
docs: update private key jwt for token instrospection ( #11227 )
...
The current document for private key JWT is misleading, as it currently
looks like a mechanism to secure an API, and it's not, this section only
shows how to use private key JWT to call the introspect endpoint
2025-12-24 20:41:48 +00:00
Federico Coppede and GitHub
e93ff33167
docs: update JWT IDP doc ( #11230 )
...
This PR provides additional clarification to the steps needed to
configure a JWT IDP in Zitadel
Fixes #7646
2025-12-24 20:38:15 +00:00
Federico Coppede and GitHub
3a2eb96e82
docs: update account linking misleading doc ( #11223 )
...
According to this
[doc](https://zitadel.com/docs/concepts/features/account-linking ), I
should be able to select if I want to authenticate with the local or
external account.
<img width="720" height="119" alt="image"
src="https://github.com/user-attachments/assets/163d44e0-39a0-462c-8beb-fd3de8b543d5 "
/>
This is not accurate.
Fixes #10161
2025-12-23 15:32:40 +00:00
Federico Coppede and GitHub
faefeaa53c
docs: update actions V2 landing page ( #11220 )
...
Updated wording on the Actions V2 landing page and added a reference to
the sample scripts repository we have to deploy Actions for various use
cases to Cloudflare Workers.
Fixes #11028
2025-12-23 12:28:54 +00:00
Federico Coppede and GitHub
3106dcfc67
docs: update database configuration page ( #11219 )
2025-12-22 17:08:12 +01:00
Federico Coppede and GitHub
11cf2c252a
chore(ux): Fix wording for application ID token settings ( #11210 )
...
When this checkbox is enabled, the user profile information (not the
roles assigned) will be returned as claims in the ID token. The current
wording is not accurate.
2025-12-18 18:13:18 +00:00
Federico Coppede and GitHub
44b7f1013f
docs: built in smtp provider warning ( #10958 )
...
Added a warning to mention that the built in SMTP provider is for
testing only, not production.
**Context:** Customers often complain about email delivery delays while
using the built in SMTP provider, and they should configure their own.
2025-10-25 10:03:56 +00:00
Federico Coppede and GitHub
74fc58cb36
docs: add clarification for error forwarding in actions v2 ( #10960 )
...
When forwarding an error from a target to Zitadel, the target
**interruptOnError** must be **true** - this clarification is missing in
the document.
2025-10-24 20:29:52 +02:00
Federico Coppede and GitHub
6c98559ec0
docs: update react app screenshot to match new quickstart UI ( #10936 )
...
Updated react quickstart app screenshot to match new UI
2025-10-20 17:04:52 +00:00
3ed3b5ee59
docs: added feedback component to all docs pages ( #10856 )
...
This PR adds a feedback box at the bottom of all the docs pages to help
us track which pages need to be updated or improved. The feedback box is
connected to plausible for event tracking.
---------
Co-authored-by: Max Peintner <[email protected]
2025-10-08 08:45:53 -03:00
Federico Coppede and GitHub
096eb4fd91
docs: update api intro and postman collection ( #10786 )
...
This PR removes the outdated swagger section and add a reference to the
Postman collection we recently published.
2025-09-26 19:04:02 -03:00
Federico Coppede and GitHub
de0667bb24
docs: added zitadel-vanilla-js link and reference ( #10807 )
...
Added a link to the new vanilla-js SPA example on the sidebar, and the
card + image on the resources here:
- https://zitadel.com/docs/sdk-examples/introduction
New sample app:
- https://github.com/zitadel/zitadel-vanilla-js
2025-09-26 16:53:33 -03:00
Federico Coppede and GitHub
44902e11b7
docs: update release cycle and support states URL to point to KBAs ( #10602 )
...
The page located here was split into 2 different KBAs:
- https://zitadel.com/docs/support/software-release-cycles-support
**Software release cycles:**
- https://help.zitadel.com/zitadel-software-release-cycle
**Support states KBA:**
- https://help.zitadel.com/zitadel-support-states
And the corresponding URLs were updated in the docs site
2025-09-22 11:29:34 +00:00
Federico Coppede and GitHub
41d04ffa65
docs: fix typo in default settings domain discovery description ( #10743 )
...
fixed typo:
If this setting is enabled, the user **does't not** mandatory -> If this
setting is enabled, the user doesn't have to...
2025-09-16 15:33:40 +00:00
756f81534a
docs: update status page URL ( #10528 )
...
old status page URL: status.zitadel.com
new status page URL: zitadelstatus.com
Co-authored-by: Florian Forster <[email protected]
2025-08-22 11:36:23 +00:00
763825cd2c
docs(guides): updated support instructions and screenshots ( #10521 )
...
Since the support form is deployed in the customer portal I updated the
instructions and screenshots.
---------
Co-authored-by: Maximilian <[email protected]
2025-08-20 10:15:11 +00:00
c83a85dee9
docs(legal): remove billing page to redirect to the HubSpot KBA URL ( #10488 )
...
Removed the billing md document and updated the links to the HubSpot KBA
-> https://help.zitadel.com/pricing-and-billing-of-zitadel-services
Co-authored-by: Maximilian <[email protected]
2025-08-18 11:21:00 -03:00
ea71da0d3f
docs (legal): Update urgent support phone number specified in support-services.mdx ( #10486 )
...
Updated urgent support phone number to **+41 71 560 28 06**
Co-authored-by: Maximilian <[email protected]
2025-08-14 17:32:30 +00:00
b7d447e313
docs(legal): Update account-lockout-policy.md ( #10124 )
...
Review finished for the account lockout policy.
Main changes:
- Revised wording
- Removed free account from the policy scope
- Fixed broken link to the support form in the customer portal
---------
Co-authored-by: Maximilian <[email protected]
2025-06-30 12:21:08 +00:00
