intelligence-docs
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseIntelligence Landing Page
Intelligence着陆页
/intelligence/overview/intelligence/overviewWhen To Use
使用场景
Load this skill when:
- A new Intelligence feature ships (threads, analytics, learning, channels, hosting, inspection, or a later pillar)
- A page is added, renamed, or removed under
showcase/shell-docs/src/content/docs/intelligence/ - The shared Intelligence overview snippet or feature cards change
Do not load it for OSS frontend guides that do not use Intelligence, or for
Inspector pane callouts ().
inspector-docs在以下场景中使用本指南:
- 新的Intelligence功能发布(线程、分析、学习、渠道、托管、检查或后续核心功能)
- 下的页面被添加、重命名或移除
showcase/shell-docs/src/content/docs/intelligence/ - 共享的Intelligence概述代码片段或功能卡片发生变更
请勿将其用于不涉及Intelligence的OSS前端指南,或Inspector面板提示()。
inspector-docsLanding sources
着陆页相关资源
Edit these in the same change as the feature or docs page:
| Surface | File |
|---|---|
Hero CTA ( | |
| Table, body, and MDX quickstart link | |
| Section nav | |
| Root sidebar Intelligence group | |
| Card and CTA tests | |
| Snippet order tests | |
The root overview page only wraps the snippet. Do not duplicate landing copy
in .
docs/intelligence/overview.mdx在添加功能或文档页面的同一变更中编辑以下内容:
| 界面区域 | 文件路径 |
|---|---|
Hero按钮( | |
| 表格、正文和MDX快速入门链接 | |
| 章节导航 | |
| 根侧边栏Intelligence分组 | |
| 卡片和按钮测试 | |
| 代码片段顺序测试 | |
根概述页面仅包裹代码片段,请勿在中重复着陆页文案。
docs/intelligence/overview.mdxProcedures
操作流程
Procedure 1: Add a feature or docs page
流程1:添加功能或文档页面
- Add or update the guide page under (or the existing threads/channels path the feature already uses).
docs/intelligence/ - Put the page in and in the Intelligence group in
intelligence/meta.jsonwhen it belongs in the sidebar.docs/meta.json - Add a row to What the platform adds in the shared snippet. The deeper dive must be a real URL.
- If the feature is a user-facing pillar, add a card to in
FEATURESwith a unique CTA label and the same URL.intelligence-overview.tsx - If the feature is a named pillar in the hero, add it to the subtitle.
- Extend the tests in the same commit. Pin the new CTA href as a literal.
- 在下添加或更新指南页面(或使用功能已有的线程/渠道路径)。
docs/intelligence/ - 若页面需显示在侧边栏,将其加入和
intelligence/meta.json的Intelligence分组中。docs/meta.json - 在共享代码片段的平台新增功能部分添加一行内容,其中“深入了解”必须指向真实URL。
- 若该功能是面向用户的核心功能,在的
intelligence-overview.tsx中添加一张卡片,包含唯一的按钮标签和相同的URL。FEATURES - 若该功能是Hero区域中提及的核心功能,将其加入副标题。
- 在同一提交中扩展测试,将新的按钮href固定为字面量。
Procedure 2: Rename or move a page
流程2:重命名或移动页面
- Update every landing CTA that pointed at the old path: table row, card
, quickstart link, and "Which page should I read next?".
href - Update files.
meta.json - Update the tests that pin those hrefs.
- 更新所有指向旧路径的着陆页按钮:表格行、卡片、快速入门链接以及“我应该阅读哪个页面?”链接。
href - 更新文件。
meta.json - 更新固定这些href的测试。
Procedure 3: Remove a feature or page
流程3:移除功能或页面
- Remove the table row, card, subtitle mention, and nav entry.
- Remove the matching test assertions.
- Do not leave a landing link to a deleted page.
- 删除表格行、卡片、副标题提及内容和导航条目。
- 删除对应的测试断言。
- 请勿保留指向已删除页面的着陆页链接。
Decision Tree
决策树
- New Intelligence feature or new Intelligence docs page: Procedure 1
- Rename or move: Procedure 2
- Remove: Procedure 3
- Docs exist but landing does not name them: stop and run Procedure 1
- 新Intelligence功能或新Intelligence文档页面:执行流程1
- 重命名或移动:执行流程2
- 移除:执行流程3
- 文档已存在但着陆页未提及:停止并执行流程1
Red Flags
警示信号
| Signal | What it means | Do instead |
|---|---|---|
| Guide merged, landing unchanged | Readers cannot find the feature | Procedure 1 in the same PR |
| Card href and table href differ | Two stories for one feature | Use one URL |
| CTA points at the marketing site when a docs page exists | Landing skips the guide | Point at the docs page |
| Hero subtitle lists a pillar with no card or table row | Copy without a path | Add both, or drop the subtitle mention |
| 信号 | 含义 | 正确做法 |
|---|---|---|
| 指南已合并,但着陆页未变更 | 用户无法找到该功能 | 在同一PR中执行流程1 |
| 卡片href与表格href不一致 | 同一功能存在两种跳转路径 | 使用统一URL |
| 当文档页面存在时,按钮指向营销网站 | 着陆页跳过了指南 | 指向文档页面 |
| Hero副标题列出了核心功能,但无对应卡片或表格行 | 文案无实际跳转路径 | 同时添加卡片和表格行,或删除副标题提及内容 |
Error Handling
异常处理
- No docs page yet: do not invent a guide. You can still add a table row that points at the current public product URL, and replace it when the guide ships.
- Feature is Intelligence-only but lives outside : still add the landing CTA. Use the real path (
docs/intelligence/,/threads, and similar)./channels
- 暂无文档页面:请勿创建虚构指南。仍可添加指向当前公开产品URL的表格行,待指南发布后替换。
- 功能仅属于Intelligence但位于之外:仍需添加着陆页按钮,使用真实路径(如
docs/intelligence/、/threads等)。/channels