docs: add description frontmatter to content pages for SEO (#11654)

2026-11-09 07:35:13 +00:00 · 2026-02-21 07:44:42 -08:00
parent afeeee87c3
commit 2c260a1f10
304 changed files with 421 additions and 46 deletions
@@ -1,5 +1,6 @@
 ---
 title: How ZITADEL Processes and Stores Secrets
+description: "How ZITADEL manages and protects secrets through encryption, hashing, and rotation mechanisms."
 sidebar_label: Secrets
 ---

@@ -1,5 +1,6 @@
 ---
 title: Zitadel's Software Architecture
+description: "The software architecture of ZITADEL, built on Event Sourcing and CQRS patterns for audit trails, consistency, and scalability."
 sidebar_label: Software Architecture
 ---

@@ -1,5 +1,6 @@
 ---
 title: Zitadel's Deployment Architecture
+description: "Overview of ZITADEL's high-availability and multi-region deployment strategies for scalable and resilient identity services"
 sidebar_label: Deployment Architecture
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL Database Structure
+description: "Overview of ZITADEL's database schema, focusing on event storage and projection tables."
 sidebar_label: Database Structure
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL Event Store
+description: "Implement Event Sourcing with ZITADEL's Event Store to track changes and derive system state from immutable events"
 sidebar_label: Overview
 ---

@@ -1,5 +1,6 @@
 ---
 title: Account linking
+description: "Link multiple identities from social or enterprise IdPs to a single ZITADEL user profile for SSO and unified auditing."
 ---

 ZITADEL supports linking user accounts from different external identity providers, such as social logins or enterprise IdPs, to a single ZITADEL user profile. This enables users to be recognized as the same user in your applications, regardless of which external account they use to log in.
@@ -1,5 +1,6 @@
 ---
 title: ZITADEL Actions
+description: "Customize authentication and authorization flows by adding custom JavaScript business logic to specific trigger points."
 sidebar_label: Actions
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL Actions v2
+description: "Execute custom logic on API calls, events, or functions with ZITADEL Actions v2 to meet specific business requirements."
 sidebar_label: Actions v2
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL's In-built Audit Trail
+description: "Track all system changes and user events with ZITADEL's audit trail to maintain historical records for compliance."
 sidebar_label: Audit Trail
 ---

@@ -1,5 +1,6 @@
 ---
 title: Custom Domain
+description: "Use your own custom domain for ZITADEL to provide a branded, professional, and secure authentication experience."
 sidebar_label: Custom Domain
 ---

@@ -1,5 +1,6 @@
 ---
 title: External User Role Assignments
+description: "Grant access to projects for external users from other organizations using ZITADEL's external user role assignments"
 ---

 ZITADEL's external user role assignment is a feature that allows you to grant access to projects within your organization to users from other organizations.
@@ -1,5 +1,6 @@
 ---
 title: Identity Brokering
+description: "Establish trust between your central IdP and third-party providers for login with preferred identity sources"
 sidebar_label: Identity Brokering
 ---

@@ -1,5 +1,6 @@
 ---
 title: Features
+description: Explore core ZITADEL features including identity brokering, audit trails, and self-service
 ---

 <Cards >
@@ -1,5 +1,6 @@
 ---
 title: "Passkeys in ZITADEL: Passwordless phishing-resistant authentication"
+description: "Implement modern phishing-resistant passwordless authentication with FIDO2 passkeys."
 sidebar_label: Passkeys
 ---

@@ -1,5 +1,6 @@
 ---
 title: Self Service in ZITADEL
+description: "Enable self-service registration, login, and profile management to reduce administrative overhead and improve user experience."
 sidebar_label: Self Service
 ---

@@ -1,6 +1,6 @@
 ---
 title: "Key Concepts"
-description: "This part of our documentation contains ZITADEL specific or general concepts required to understand the system or our guides."
+description: "Learn about ZITADEL's core architecture and terminology. This section covers identity management concepts, multi-tenancy, and technical structures essential for understanding our platform."
 ---

 {/* THIS FILE IS AUTO-GENERATED FROM SIDEBAR-DATA.
@@ -1,5 +1,6 @@
 ---
 title: Knowledge
+description: Explore technical concepts and knowledge base articles for ZITADEL identity management
 ---

 <Cards >
@@ -1,5 +1,6 @@
 ---
-title: "Opaque Tokens in Zitadel: Enhancing Application Security"
+title: "Opaque Tokens in Zitadel"
+description: "Introduction to opaque tokens in ZITADEL, their security benefits, and how to validate them via the introspection endpoint"
 sidebar_label: Opaque tokens
 ---

@@ -1,5 +1,6 @@
 ---
 title: Principles
+description: "Overview of ZITADEL's core engineering and design principles, emphasizing transparency, scalability, and event sourcing."
 ---

 ## ZITADEL engineering and design principles
@@ -1,5 +1,6 @@
 ---
 title: Administrators
+description: "Overview of administrative roles in ZITADEL, ranging from System Users to Instance and Organization Admins."
 sidebar_label: Administrators
 ---

@@ -1,9 +1,10 @@
 ---
 title: ZITADEL's Granted Projects
+description: "Delegate user management for project roles to external organizations using Project Grants."
 sidebar_label: Granted Projects
 ---

-# Granted Project
+## Granted Project

 ![Project Grant](../../../public/img/concepts/objects/project_grants.png)

@@ -1,5 +1,6 @@
 ---
 title: Structure
+description: Explore the hierarchical structure of ZITADEL instances, organizations, and resource ownership
 ---

 <Cards >
@@ -1,5 +1,6 @@
 ---
 title: Instances
+description: "Overview of ZITADEL Instances—the virtual tenants providing full data isolation and independent settings."
 sidebar_label: Instances
 ---

@@ -1,5 +1,6 @@
 ---
 title: ZITADEL Settings and Policies
+description: "Manage and override default behaviors with policies for authentication, password complexity, and security."
 sidebar_label: Setting and Policies
 ---