Repository navigation
Doc Review 2026-10-08 — CLI integration group & dashboard commands, stale API counts - #1024
Merged
Merged
Conversation
… commands, API counts - cli.mdx: add the new top-level integration command group to the coverage list - cli.mdx: correct the OpenAPI operation counts 338/334 -> 365/361 - cli.mdx: document monit dashboard-* and folder-list commands - personal-settings.mdx: drop Xiaomi from the Android app store list (delisted in console) - vs-pagerduty.mdx: 334 -> 361 generated CLI commands
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-08
Mode: diff (since 2026-10-07T08:02:09Z)
Findings: 5 total — 0 high, 2 medium, 3 low
窗口内 7 个源仓库有提交(fc-foundation-app 5、fc-safari 9、flashduty-cli 2、flashduty-website 3、flashduty-app 3、monit-webapi 1、flashduty-runner 2),其余 9 个映射仓库按
git rev-list -1 --before计算的窗口起点提交与origin/<默认分支>当前 SHA 完全相同(fc-event/fc-oncall/fc-datasource/fc-pgy/fc-rum/fc-statuspage/flashduty-mcp-server/terraform-provider-flashduty/go-flashduty)。Changes
zh/developer/cli.mdx+en/developer/cli.mdxintegration(info / list / type-list / create / update / delete / enable / disable / key-rotate)zh/developer/cli.mdx+en/developer/cli.mdxzh/developer/cli.mdx+en/developer/cli.mdxdashboard-*命令与folder-list的用法,并说明--expected-revision乐观锁与「删除进回收站、保留 30 天」zh/on-call/configuration/personal-settings.mdx+en/on-call/configuration/personal-settings.mdxzh/on-call/comparison/vs-pagerduty.mdx+en/on-call/comparison/vs-pagerduty.mdxflashduty-cliinternal/cli/zz_generated_manifest.go的generatedOpIDs在窗口起点是 334 条、现在 361 条;同一窗口内本仓库api-reference/openapi.{zh,en}.json是 365 个操作。365 − 361 = 4,与文档列出的 4 条手工实现命令逐一对应,两个数字互相印证。docs.json。Review checklist
--expected-revision/ 回收站保留 30 天的说法取自flashduty-cliinternal/cli/zz_generated_dashboards.go的生成帮助文本Cross-repo follow-ups (flashduty-website)
None.
本轮 flashduty-website 的窗口变更只有 2 篇博客(
content/blog/redis-actor-session-runtime.mdx及其中文版与配图),不属于derivative_surfaces.website_changelog的content/changelog/目录,也不构成产品功能发布,因此没有派生面 findings;官网更新日志与集成目录无需改动。Mapping warnings
derivative_surfaces.comparison_page.paths指向on-call/quickstart/comparison.mdx,该文件不存在(实际产品对比页在on-call/comparison/vs-pagerduty.mdx与vs-opsgenie.mdx)。这是连续第 5 轮出现同一个问题(此前 PR docs: doc-review 2026-10-02 (diff) — AI SRE nav, context file tree, borrowed-integration vendor cards #939 上报过),该派生检查在 skill 里一直是空转的,本轮按实际目录人工补跑,产品对比页命中 f005。修复位置在 skill 的mapping.yaml,不在 docs 仓库。fc-foundation-app的 6 个子模块(src/Packages/{saas,monit,rum,ai-sre,ai-assistant,meow-ui})按.gitmodules映射为独立仓库克隆单独核对——本轮fc-saas-monit的窗口起点与 HEAD 相同,无变更。Skipped
以下候选经核对后不落地(含理由):
incident_listtypes/dashboard/{contract,validate,variants}.go、logic/logic_dashboard_runtime.gofc-saas-monit全仓无incident_list字样、窗口内无提交,即无渲染器落地。按「前端为准」规则,后端保留类型不入文档;API 契约侧已由本仓库 api-reference(PR #1023)覆盖consoleRum应用设置src/store/types.ts、src/utils/flashcat-rum.ts、src/pages/OnPremises/Settings.tsxapp_settings页面(app_settings/rumIngestEndpoint在 zh、en 全量正文中 0 命中),没有可编辑的目标文档;该仓库自带的docs/app-settings.md已在同一提交内同步@flashcatcloud/browser-rum^0.0.5 → ^0.3.0package.jsonsessionOnError/sessionReplayOnError语义本仓库zh/rum/quickstart/app-management.mdx已有「异常会话补采」条目src/pages/incident/detail/(Timeline)/StepTemp.tsx、types.ts、zh、en的incident.jsonvia字段与 PC 行为均在窗口之前就已存在,属窗口前的既有缺口;且本仓库无描述时间线署名规则或无对应目标页dingtalk_app_war_room_enabled/slack_app_war_room_enabledinternal/cli/zz_generated_notification_templates.go、fc-safarireference/template.mdzh/on-call/advanced/war-room.mdx说明「创建作战室」按钮由通知模板的卡片字段开关控制(默认关闭)。生成命令的入参按文档既定口径由--help探索,不再逐字段入正文safari session-list --person-ids、has_open_tasksinternal/cli/zz_generated_sessions.go、fc-safarireference/safari.md--help逐层探索etc/environment.ymllatestlogic/contextedit/plan.go、cmd/api/knowledge/knowledge.go知识包0 命中(仅 1 处 2026 年历史更新日志条目保留当时措辞)EventContent新增source/task_id/agent_name/wait_for_replytypes/session.goscripts/bundle-tools.sh、scripts/tool-checksums.txtlatest不锁版本