Skip to content

Commit 8093c51

Browse files
ysyneuclaude
andauthored
docs: add API reference developer guide, catalog, and bilingual sidebar (#43)
* docs: add API reference with developer guide, catalog, and bilingual sidebar - Add x-mint.href /en/ prefix to all EN OpenAPI specs (was missing, caused 404) - Add x-mint.metadata.sidebarTitle to all operations for correct bilingual sidebar labels - Create developer guide pages: Quick Start (merged rate-limits), API Catalog, Pagination - Quick Start includes Open API vs Webhooks/Events comparison at top - API Catalog lists all 214 endpoints with clickable links organized by module - Move route rules outside channels group, next to integrations - Navbar API Reference link points to Quick Start page - Update pagination page links from old docs URLs to new API reference paths - Remove RequestExample from introduction (not an API schema page) Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * docs: move glossary to repo root, update README, add Developer section to home - Move glossary.md from .cursor/skills/ to repo root for easier access - Update CLAUDE.md, README.md, README_zh.md to reference new glossary path - Add api-reference/ and glossary.md to directory structure in READMEs - Add Developer section to both zh/home.mdx and en/home.mdx with links to Quick Start, API Catalog, and Pagination pages Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 909fe65 commit 8093c51

23 files changed

Lines changed: 141055 additions & 143 deletions

CLAUDE.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,13 +27,15 @@ Prerequisite: `npm i -g mint`
2727

2828
- **`docs.json`** — Central Mintlify config: navigation structure, tabs, theme. All new pages must be registered here under the correct language → tab → group.
2929
- **`zh/`** and **`en/`** — Mirror each other. Chinese is the source of truth; English is translated from it.
30-
- **`.cursor/skills/`** — AI agent skills for translation (`translate-zh-to-en`) and polishing (`polish-document`), with glossary and standards resources.
30+
- **`glossary.md`** — Chinese-English terminology glossary for translation consistency.
31+
- **`api-reference/`** — OpenAPI 3.1 spec files (per-module, per-language) powering the API Reference tab.
32+
- **`.cursor/skills/`** — AI agent skills for translation (`translate-zh-to-en`) and polishing (`polish-document`).
3133

3234
## Documentation Workflow
3335

3436
1. Create/edit Chinese docs in `zh/` as `.mdx` files
3537
2. Add the page path to `docs.json` navigation (both `zh` and `en` language sections)
36-
3. Translate to English using the glossary at `.cursor/skills/translate-zh-to-en/glossary.md`
38+
3. Translate to English using the glossary at `glossary.md`
3739
4. Run `mint broken-links` to validate
3840

3941
## Key Terminology (zh → en)
@@ -57,7 +59,7 @@ These are non-obvious translations that must stay consistent:
5759
| 规则告警聚合 | pattern alert grouping |
5860
| 智能告警聚合 | intelligent alert grouping |
5961

60-
Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md`
62+
Full glossary: `glossary.md`
6163

6264
## Writing Conventions
6365

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ flashduty-docs/
9292
│ ├── compliance/ # Security compliance
9393
│ └── changelog/ # Changelog
9494
├── en/ # English docs (mirrors zh/)
95+
├── api-reference/ # OpenAPI 3.1 specs (per-module, per-language)
96+
├── glossary.md # Chinese-English terminology glossary
9597
├── docs.json # Mintlify configuration & navigation
9698
└── logo/ # Logo assets
9799
```
@@ -121,7 +123,7 @@ Chinese is the source language; English is translated from it. When translating:
121123
| 抑制策略 | inhibit rule |
122124
| 排除规则 | drop rule |
123125

124-
Full glossary: `.cursor/skills/translate-zh-to-en/glossary.md`
126+
Full glossary: [`glossary.md`](glossary.md)
125127

126128
---
127129

README_zh.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -92,6 +92,8 @@ flashduty-docs/
9292
│ ├── compliance/ # 安全合规
9393
│ └── changelog/ # 更新日志
9494
├── en/ # 英文文档(与 zh/ 结构一致)
95+
├── api-reference/ # OpenAPI 3.1 规范文件(按模块和语言拆分)
96+
├── glossary.md # 中英术语对照表
9597
├── docs.json # Mintlify 配置与导航
9698
└── logo/ # Logo 资源
9799
```
@@ -121,7 +123,7 @@ flashduty-docs/
121123
| 抑制策略 | inhibit rule |
122124
| 排除规则 | drop rule |
123125

124-
完整术语表见 `.cursor/skills/translate-zh-to-en/glossary.md`
126+
完整术语表见 [`glossary.md`](glossary.md)
125127

126128
---
127129

0 commit comments

Comments
 (0)