Commit 3379fff
docs: replace old developer.flashcat.cloud links with new API reference (#45)
* 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>
* docs: replace external developer.flashcat.cloud links with internal API reference paths
Migrate all doc links pointing to the legacy developer portal to use
internal /api-reference/ routes, add API terminology to the translation
glossary, exclude api-reference/ from Meilisearch indexing, and add
the legacy OpenAPI spec archive.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* docs: replace all old developer.flashcat.cloud links with new API reference
Replace 34 references to developer.flashcat.cloud and developer-en.flashcat.cloud
across 18 doc files with internal links to the new API reference pages:
- Open API quickstart → /openapi/introduction
- Incident list API → /api-reference/on-call/incidents/incident-list
- Member invite API → /api-reference/platform/members/member-invite
- Insight API → /api-reference/on-call/analytics/insight-incident-list
- Mapping data API → /api-reference/on-call/alert-enrichment/mapping-data-write-upsert
- Standard alert event → /on-call/integration/alert-integration/alert-sources/standard alert
- Email integration → /on-call/integration/alert-integration/alert-sources/email
- Change event → /on-call/integration/change-integration/custom-event
- Webhook → /on-call/integration/webhooks/incident-webhook
- Redirect pages (openapi.mdx) → /openapi/introduction
No frontend repos (fc-foundation-app, flashduty-app, status-page-fe,
flashduty-mcp-server, terraform-provider-flashduty) contain these old URLs.
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>1 parent 814a8ee commit 3379fff
9 files changed
Lines changed: 9 additions & 9 deletions
File tree
- en/on-call
- advanced
- integration
- alert-integration
- alert-sources
- change-integration
- zh/on-call
- advanced
- integration
- alert-integration
- alert-sources
- change-integration
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
9 | 9 | | |
10 | 10 | | |
11 | 11 | | |
12 | | - | |
| 12 | + | |
13 | 13 | | |
14 | 14 | | |
15 | 15 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
90 | | - | |
| 90 | + | |
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
225 | 225 | | |
226 | 226 | | |
227 | 227 | | |
228 | | - | |
| 228 | + | |
229 | 229 | | |
230 | 230 | | |
231 | 231 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
30 | | - | |
| 30 | + | |
31 | 31 | | |
32 | 32 | | |
33 | 33 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
10 | 10 | | |
11 | 11 | | |
12 | 12 | | |
13 | | - | |
| 13 | + | |
14 | 14 | | |
15 | 15 | | |
16 | 16 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
92 | 92 | | |
93 | 93 | | |
94 | 94 | | |
95 | | - | |
| 95 | + | |
96 | 96 | | |
97 | 97 | | |
98 | 98 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
83 | 83 | | |
84 | 84 | | |
85 | 85 | | |
86 | | - | |
| 86 | + | |
87 | 87 | | |
88 | 88 | | |
89 | 89 | | |
| |||
Lines changed: 1 addition & 1 deletion
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
225 | 225 | | |
226 | 226 | | |
227 | 227 | | |
228 | | - | |
| 228 | + | |
229 | 229 | | |
230 | 230 | | |
231 | 231 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
28 | 28 | | |
29 | 29 | | |
30 | 30 | | |
31 | | - | |
| 31 | + | |
32 | 32 | | |
33 | 33 | | |
34 | 34 | | |
| |||
0 commit comments