mirror of
https://github.com/andwati/zitadel.git
synced 2026-10-18 21:52:54 +00:00
4586708c06
## Problem ZITADEL has inconsistent naming across docs, UI, and API ([#5888](https://github.com/zitadel/zitadel/issues/5888)). We want contributors and Copilot code-review agents to flag discouraged terms and suggest canonical replacements automatically. ## Solution Add a **Markdown terminology catalog** that Copilot agents read natively. ### What's added - **`TERMINOLOGY.md`** (repo root) — full ~35-term canonical table from issue #5888 with: - Action legend: `keep` / `replace` / `remove` / `internal` / `proposed` - Scope legend: `UI` / `Docs` / `API` / `Everywhere` - "Search for (discouraged)" and "Replace with / enforce" columns - Governance section (how to add new terms, ownership) - **`.github/instructions/terminology.instructions.md`** — Copilot `applyTo`-scoped instruction that activates on every PR touching docs/i18n/proto files and tells the agent: - Which files map to which scope - Not to flag identifiers/field names in proto files (only comments/descriptions) - To request catalog updates when new terms are introduced ### What's updated - `.github/copilot-instructions.md` — points to `TERMINOLOGY.md` - `apps/docs/AGENTS.md` — updated reference, removed dead `check-terminology` Nx target entry - `.github/pull_request_template.md` — checklist item updated - `.github/workflows/ready_for_review.yml` — checklist item updated ### Why Markdown over JSON | | Markdown | JSON | |---|---|---| | Copilot reads natively | yes | no (needs parsing context) | | Mirrors AGENTS.md table style | yes | no | | Human-readable without tooling | yes | no | | Mirrors the #5888 issue format | yes | no | | Requires schema / parser | no | yes | ### Why root over `.github/` `.github/` is for GitHub-specific automation files. `TERMINOLOGY.md` is a project-wide convention document — it belongs alongside `CONTRIBUTING.md`, `CODE_OF_CONDUCT.md`, and `AGENTS.md` at the repo root. ## How it works in practice When a PR touches `apps/docs/content/**`, `console/src/assets/i18n/**`, `apps/login/locales/**`, or `proto/**/*.proto`, Copilot code review automatically loads `.github/instructions/terminology.instructions.md` and cross-references `TERMINOLOGY.md` to flag discouraged terms. Human reviewers see the terminology checklist in the auto-comment on PR open. ## Checklist - [x] `TERMINOLOGY.md` at repo root with all ~35 terms from #5888 - [x] Plain text action/scope values (no emojis) - [x] Copilot instruction file scoped to correct file patterns - [x] All stale `terminology-rules.json` references removed - [x] No linter/CI step added (guidelines-only approach) Relates to: #5888 --------- Co-authored-by: Copilot <[email protected]> Co-authored-by: Fabienne Bühler <[email protected]>
26 lines
1.4 KiB
Markdown
26 lines
1.4 KiB
Markdown
# ZITADEL Docs Guide for AI Agents
|
|
|
|
## Context
|
|
The **Docs App** (`apps/docs`) hosts the ZITADEL documentation. It has recently migrated to **Fumadocs**.
|
|
|
|
## Key Technology
|
|
- **Framework**: Fumadocs (built on Next.js).
|
|
- **Content**: MDX (Markdown + React Components).
|
|
- **Orchestration**: Nx.
|
|
|
|
## Content Conventions
|
|
- **Frontmatter**: Ensure standard Fumadocs frontmatter is used (title, description).
|
|
- **Links**: Use absolute paths or standard MDX linking.
|
|
- **Components**: Use only MDX components that are documented in the official Fumadocs MDX component reference and any project-specific MDX component documentation in this repo; do not introduce or rely on undocumented components.
|
|
- **API Docs**: Changes in `proto/` or API response schemas often require regeneration via docs generation targets.
|
|
- **Terminology**: For user-facing naming changes in docs/UI/API descriptions, follow `TERMINOLOGY.md` (issue #5888 source). Copilot code review will flag discouraged terms automatically on PRs touching these paths.
|
|
|
|
## Verified Nx Targets
|
|
- **Dev Server**: `pnpm nx run @zitadel/docs:dev`
|
|
- **Build**: `pnpm nx run @zitadel/docs:build`
|
|
- **Generate**: `pnpm nx run @zitadel/docs:generate`
|
|
- **Lint**: `pnpm nx run @zitadel/docs:lint`
|
|
- **Check Links**: `pnpm nx run @zitadel/docs:check-links`
|
|
- **Check Types**: `pnpm nx run @zitadel/docs:check-types`
|
|
- **Test**: `pnpm nx run @zitadel/docs:test`
|