Repository navigation
docs: doc-review 2026-10-02 (diff) — AI SRE nav, context file tree, borrowed-integration vendor cards - #939
Merged
Merged
Conversation
… nav, context file tree, borrowed-integration vendor cards
Window: 2026-09-30T16:35:38Z -> 2026-10-02T02:03Z
Findings: 6 total (1 medium, 5 low) — 3 applied, 2 skipped, 1 cross-repo
- environments/quickstart: the self-hosted/cloud switch moved from top tabs to a
left menu; the docs still pointed at a tab at the top of the page.
- knowledge: the Context page's file panel is now a collapsible directory tree
(DUTY.md pinned, folders before files); the docs described a flat list.
- integrate-data (+ quickstart step two): the integration-type picker now also
lists 28 vendor doc-cards that borrow another integration type; documented the
list, alias search and what actually gets saved.
- cubeapm / red-hat-openshift: the disambiguation clause was copy-pasted from
chronosphere.mdx ("not Chronosphere"); corrected in both locales.
# Conflicts: # en/ai-sre/environments.mdx # en/ai-sre/knowledge.mdx # en/ai-sre/quickstart.mdx # zh/ai-sre/environments.mdx # zh/ai-sre/knowledge.mdx # zh/ai-sre/quickstart.mdx
…table (29 vendors)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Doc Review — 2026-10-02
Mode: diff (since
2026-09-30T16:35:38Z, the last successful run)Findings: 6 total — 0 high, 1 medium, 5 low · applied 3, skipped 2, cross-repo 1
Window and method
Window
2026-09-30T16:35:38Z→2026-10-02T02:03Z. All 17 mapped repos were cloned/fetched and diffedagainst
origin/<default-branch>(never the local checkout); thefc-foundation-appsubmodules(
saas,monit,rum,ai-sre, plusai-assistant,meow-ui) were initialised with their SSH URLsrewritten to HTTPS and diffed from inside the submodule, with
.gitmodulesrestored afterwards.Only four areas had in-window changes:
fc-datasource(structs/plugin.go),fc-foundation-app(
saasandai-sresubmodules),fc-safari(cmd/api/knowledge/knowledge.go). The other 14 repos hadnone. Test/spec files and image assets were filtered out of the diff set before analysis.
The bulk of the AI SRE diff (~60 of 62 files) turned out to be a mechanical
antd→@flashcatcloud/meow-uimigration (Spin→Spinner,size='small'→'sm',onChange→onValueChange/
onCheckedChange, raw segment buttons →Tabs.Root): no user-visible field, option, limit or defaultchanged, so it produced no findings.
The
fc-datasourcediff registers 75 newPlugAlert*values and 12 newPlugChange*values. Every oneof the 87 already has zh + en doc pages and is registered in
docs.json, and all 75 alert slugs arepresent in the website catalog — so there were no missing-integration pages to write.
Changes
feature_driftzh/en/ai-sre/environments.mdx:62,zh/en/ai-sre/quickstart.mdx:105missing_coveragezh/en/ai-sre/knowledge.mdx:76DUTY.mdis pinned to the top (still labelled 使用说明), folders sort before files and same-level entries sort by name. Added one sentence describing this, both locales.missing_coveragezh/en/on-call/channel/integrate-data.mdxdocCards.ts), the alias search (VSPC/PDU/WUG/UPS/OCP/Azure Sentinel/Bro…), and the fact that opening a card lands on the borrowed type's creation page while what gets saved is the borrowed type. Both "select alert type" steps now point at it.feature_driftzh/en/.../alert-sources/cubeapm.mdx:14,.../red-hat-openshift.mdx:14chronosphere.mdx— "集成类型都选择 Prometheus,不是 Chronosphere" / "not Chronosphere". Corrected to 不是 CubeAPM / 不是 Red Hat OpenShift (en: "not CubeAPM" / "not Red Hat OpenShift"). The prescriptive half was already right; only the vendor name was wrong.All 28 doc-card pages were also checked against
docCards.ts: every page exists, is indocs.json, andits stated borrowed type matches the
viafield. No other page has a mismatched disambiguation clause.mint broken-links→ no broken links (run after all edits).Review checklist
docCards.tsCross-repo follow-ups (flashduty-website)
messages/zh.json+messages/en.json, severity low. Both files state "60+" in ~11 places(including
stats.integrations.value), while the same repo'slib/integrations/catalog.tsdefines 274category: "alert-sources"entries (318+ total incl. instant-messaging / webhooks-sync / other) andapp/[locale]/integrations/_components/integrations-catalog.tsx:165renderscategoryEntries.lengthdynamically. The static copy therefore contradicts the count the site itself renders. Suggested action:
bump the number, or derive it from
INTEGRATION_CATALOGso it cannot drift again. Not edited here — itis a flashduty-website change.
Mapping warnings
derivative_surfaces.comparison_page.pathsinmapping.yamlpoints at files that do not exist:zh/on-call/quickstart/comparison.mdxzh/on-call/comparison/vs-pagerduty.mdxandzh/on-call/comparison/vs-opsgenie.mdxen/on-call/quickstart/comparison.mdxen/on-call/comparison/Worth fixing in the skill's
mapping.yamlso the comparison surface is actually checked on future runs.Skipped
f005 — integration-count claims, severity low, not edited (needs a product decision).
zh/home.mdx:84says "丰富集成:50+ 告警源原生支持" /en/home.mdx:83"Native support for 50+ alertsources", while
zh/en/on-call/comparison/vs-pagerduty.mdx:180andvs-opsgenie.mdx:140say"60+ 集成源" / "60+ integration sources". Two different numbers for the integration inventory now coexist
in the repo, and both sit far below the 277 documented alert-source pages per locale.
Left for a human because the correct number depends on a definition — native plugin types vs. documented
pages vs. discoverable cards (the 28 borrowed-integration vendors above are not native types) — and because
zh/home.mdx's "50+" is not an accident: doc-review 2026-08-13 (f9745679) deliberately lowered it from"100+" to "50+". Raising a marketing number unilaterally would risk introducing a wrong claim, so the
recommendation is to pick one canonical definition and apply it to all four locations at once.
Notes (checked, not filed)
zh/ai-sre/apps.mdx:34calls the Plugins rail entries "标签页" even though they are a left menu ofbuttons. That wording predates this window — the rail was already a left menu before this diff — and the
item set/order (概览 / Apps / Skill / MCP / Agents) is unchanged, so no edit was made.
antd→meow-uimigration touched ~60 AI SRE files including pagination, scope bar, toolbars andspinners; all were checked for changed limits/options/defaults and none were found.
fc-safari cmd/api/knowledge/knowledge.gonow returns an empty document (instead of 404) when a fileis opened before it exists; no doc page states the 404 behaviour, so no drift.
missing_coverage/feature_driftfindings at high or medium severity, and the only documentable newfeature here (the vendor cards) is low. The preceding run's open PR docs: doc-review 2026-09-30 (diff) — dashboards page, RUM repository linking, on-prem license reminders #790 already carries a 2026-09-30
changelog entry covering the integration wave.