人工智能AI Agent代码智能体开发工具工具调用RAG【免费下载链接】continueopen-source coding agent项目地址https://gitcode.com/GitHub_Trending/co/continue点击查看免费下载在 Continue 开源仓库中.continue/rules目录下维护着一组供 Agent 执行的工作规则rules其中documentation-description-rule.md专门约束docs/目录下所有文档页面的 frontmatterdescription字段。本指南以这条规则为核心讲解 Continue 文档体系中 description 字段的编写标准100–160 字符、关键词丰富、行为导向、它在站点渲染与 SEO 中的实际消费链路以及如何结合仓库源码与现有文档样本写出一条高质量的页面描述。读完本文你将能为任何 Markdown/MDX 文档页面编写规范、可检索、可被搜索引擎与 LLM 正确理解的 description并理解其背后的工程机制。规则从何而来一条面向文档的 Agent 规则文件.continue/rules/documentation-description-rule.md是 Continue 项目内部使用的一则 Agent 规则。它使用 YAML frontmatter 声明自身属性--- globs: docs/**/*.{md,mdx} description: This rule applies to all documentation files to ensure consistent SEO optimization and improve discoverability. It helps users and search engines understand the content of each page before reading it. ---其中globs: docs/**/*.{md,mdx}声明该规则的适用范围仓库docs/目录下所有的 Markdown.md与 MDX.mdx文档文件。当 Agent 处理的文件上下文命中该 glob 模式时规则会被纳入考量。description则是对规则自身的概括说明其目标是保证一致的 SEO 优化并提升可发现性discoverability让用户和搜索引擎在阅读页面正文之前先理解页面内容。从 Continue 的规则加载机制看这类.continue/rules目录下的 Markdown 规则文件由 core/config/markdown/loadMarkdownRules.ts 负责加载它会扫描工作区及全局.continue/rules与.continue/prompts目录下的全部.md文件通过markdownToRule解析 frontmatter 与正文并根据globs、alwaysApply等字段决定规则在何种上下文生效。因此这条 description 规则并不是“人肉约定”而是 Continue 的 Agent 在撰写或评审docs/文档时会真正读取并执行的规范。description 字段的核心规范规则正文给出了对每个文档页面的硬性要求Every file in the docs folder must include a description field in its frontmatter that accurately summarizes the content of the page in 100-160 characters. The description should be concise, keyword-rich, and explain what users will learn or accomplish from the page.拆解成可执行的检查点如下检查点要求说明必须性docs/下每个文件都必须有description字段位于 frontmatter文件顶部的---包裹区内缺一不可长度100–160 字符既不能过短信息不足也不能超过搜索引擎摘要展示的典型长度准确性精确概括页面内容描述必须与页面正文一致不能夸大或跑题关键词关键词丰富keyword-rich自然融入用户可能搜索的术语利于检索与排名行为导向说明用户将学到什么或完成什么使用 “Learn how to…” / “How to…” 这类结果导向句式frontmatter 的位置与格式description必须放在文档顶部的 YAML frontmatter 中与title、keywords等字段并列。以仓库中真实文档 docs/chat/how-to-use-it.mdx 为例--- title: Chat sidebarTitle: How To Use Chat Mode icon: circle-question description: Learn how to use Continues Chat mode to solve coding problems without leaving your IDE, including code context sharing, applying generated solutions, and switching between models ---再看 docs/customize/deep-dives/configuration.mdx--- title: How to Configure Continue description: Learn how to access and manage Continue configurations through local YAML files keywords: [config, settings, customize] sidebarTitle: Configuration ---两个真实样本都遵循了同一句式以 “Learn how to…” 开头直接告诉读者“读完这一页你能做什么”并在描述中嵌入核心关键词Chat mode、coding problems、IDE、configurations、YAML files 等。如何写出一条高质量 description好与坏的对照基于规则要求与仓库样本可以把“高质量 description”的写法归纳为四条原则以行为结果开头优先使用 “Learn how to…”“How to…” 等动词短语明确读者能完成的任务而不是描述页面“讲了什么”的静态陈述。携带核心关键词把用户检索时会输入的关键词功能名、模式名、配置项、技术名词自然嵌入描述避免堆砌。控制在 100–160 字符长于 160 字符会被搜索引擎截断短于 100 字符则信息量不足、难以覆盖关键词。与页面内容严格一致description 是页面内容的高保真摘要不是营销文案docs/页面的描述应如实反映该页的实操内容。对照示例# ❌ 静态描述、无行为导向、缺少关键词 description: This page is about the Chat mode. # ❌ 超长、罗列性堆砌、信息密度低 description: This page talks about Chat mode and also covers code context and how you can include code in your messages and also discusses applying solutions and switching between models and many other topics in great detail. # ✅ 行为导向、关键词丰富、符合长度区间 description: Learn how to use Continues Chat mode to solve coding problems without leaving your IDE, including code context sharing, applying generated solutions, and switching between models从仓库现状看docs/customize/deep-dives/prompts.mdx 的description: Prompts are used to kick off tasks for Agent mode, Plan mode, and Chat mode是另一个以“功能即用途”方式概括页面的好样本——它一句话点明 Prompts 是什么、用在哪些模式中关键词Prompts、Agent mode、Plan mode、Chat mode全部自然出现。从 frontmatter 到页面与搜索引擎description 的消费链路description字段并不只是给搜索引擎看的“元数据”在 Continue 仓库的文档站实现中它同时驱动了页面元信息与页面顶部导语两处渲染。在 docs-site/app/[[...slug]]/page.tsx 中generateMetadata将 frontmatter 中的description直接写入 Next.js 页面元数据第 49–59 行成为搜索引擎抓取的meta namedescription内容export async function generateMetadata({ params }: Props): PromiseMetadata { const { slug } await params; const doc await loadMdxFile(slug || [index]); if (!doc) return {}; return { title: doc.frontmatter.title ? ${doc.frontmatter.title} | Continue Docs : Continue Docs, description: doc.frontmatter.description || , }; }同时页面正文顶部会把 description 渲染为一段导语文字第 122–126 行并去除可能的加粗符号{doc.frontmatter.description ( p classNamemb-8 text-lg text-black/50 dark:text-white/50 {doc.frontmatter.description.replace(/\*\*/g, )} /p )}这意味着一份高质量的 description 会同时带来三重收益搜索引擎可读性作为 meta description 出现在搜索结果摘要中页面可读性作为页面开头的导语帮助读者在滚动之前确认本页内容Agent/LLM 可读性frontmatter 是结构化的文本元数据被持续集成到知识检索与文档索引流程中方便后续 Agent 检索时快速判断页面相关性。与相邻规则的配合完整的文档 frontmatter 体系documentation-description-rule.md并非孤立存在它与.continue/rules目录下的其他规则共同构成 Continue 文档编写规范.continue/rules/documentation-standards.md文档风格指南要求页面在 frontmatter 中同时包含title、description和keywords并使用从##开始的统一标题层级。这意味着description是文档 frontmatter 三要素之一与标题、关键词并列。.continue/rules/mintlify-formatting.md 约束文档中Card、Info、Tip等 Mintlify 组件的格式规范确保文档正文结构统一。.continue/checks/update-continue-docs.md 是仓库的文档更新检查 Agent 规则它明确要求“保持既有 frontmattertitle、description与原文完全一致不得随意改动”并规定“新页面需加入 docs/docs.json 导航文件”——这从变更管理层面保护了 description 的稳定性避免在文档迭代中无意识地破坏已优化的元数据。因此一次合规的文档编写流程通常是为新页面在docs.json中注册导航 → 编写正文遵循 Mintlify 格式与风格指南→ 在 frontmatter 中补齐title、description、keywords→ 其中description严格按本规则控制在 100–160 字符并行为导向。规则如何被加载与触发globs 匹配机制要理解这条规则在实际 Agent 工作流中何时生效需要了解 Continue 的规则匹配机制。根据 core/config/markdown/loadMarkdownRules.ts 的实现规则文件的 frontmatter 会决定其触发条件globs当被处理文件如某个docs/下的.mdx匹配该模式时规则被纳入上下文。本规则的docs/**/*.{md,mdx}即精确覆盖全部文档页。alwaysApply若为true则无条件生效为false时结合 globs 匹配结果或由 Agent 依据规则自身的description判断是否拉取。未显式设置alwaysApply本规则即如此时按默认行为存在 globs 时“命中即生效”。换言之当 Agent 在 Continue 中处理docs/目录下的任何 Markdown/MDX 文件例如按 .continue/checks/update-continue-docs.md 的指示更新文档时documentation-description-rule.md会作为约束条件进入其上下文要求输出文件中包含合规的description字段。此外Continue 还支持以.continuerules文件见 core/config/getWorkspaceContinueRuleDotFiles.ts和AGENTS.md、CLAUDE.md等 Agent 文件形式提供规则共同组成了工作区规则体系.continue/rules中的 Markdown 规则是其中最便于维护、粒度最细的一层。自查清单写完后如何验证在提交或接受一个docs/文档变更前可以按以下清单逐项检查 description文件位于docs/下且 frontmatter 中存在description字段缺一不可长度在 100–160 字符之间以行为/结果导向的动词短语开头如 “Learn how to…”而不是静态陈述自然嵌入该页核心关键词功能名、模式名、配置项、技术名词与正文内容严格一致无夸大、无营销化措辞未擅自改动既有文档已存在的title/description遵循 .continue/checks/update-continue-docs.md 的约束。同时可借助 Continue 自身的规则加载机制进行验证在 IDE 中打开目标文档并唤起 Agent 处理时观察.continue/rules/documentation-description-rule.md是否随 globs 命中而被纳入上下文若命中Agent 会按照上述清单对 description 进行补写或修正。小结.continue/rules/documentation-description-rule.md用一句简明规则定义了 Continue 文档工程中最容易被忽略、却直接决定 SEO 与可发现性的环节每个docs/页面必须在 frontmatter 中携带一段 100–160 字符、关键词丰富、行为导向的description。这条规则的价值在仓库的工程链路中得到了完整闭环——docs-site/app/[[...slug]]/page.tsx 将 description 同时输出为 meta description 与页面导语core/config/markdown/loadMarkdownRules.ts 保障规则被 Agent 可靠加载.continue/rules/documentation-standards.md 与 .continue/checks/update-continue-docs.md 则从编写与变更管理两侧守护其质量。理解并遵循这条规则是参与 Continue 文档维护、或为自己的文档工程建立同样规范的第一块基石。赞分享人工智能AI Agent代码智能体开发工具工具调用RAG【免费下载链接】continueopen-source coding agent项目地址https://gitcode.com/GitHub_Trending/co/continue点击查看免费下载相关推荐Mastra 集成页面写作指南从零编写高质量集成文档的完整规范Mastra 集成页面写作指南从零编写高质量集成文档的完整规范 本篇指南系统讲解 Mastra 开源仓库中 docs/src/content/en/integ人工智能Agent 框架AI AgentRAG后端Front-End Checklist 之 Meta Description 完整指南为每个页面编写高质量网页描述Front End Checklist 之 Meta Description 完整指南为每个页面编写高质量网页描述 meta namedescripti没有 TPM 2.0 的老电脑如何用 Rufus 绕过硬件检查装上 Windows 11没有 TPM 2.0 的老电脑如何用 Rufus 绕过硬件检查装上 Windows 11 Windows 11 安装器弹出「此电脑不满足最低系统要求」没有桌面应用开发工具创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考