为 Continue 文档做出贡献

🚀 快速开始

先决条件

1. Node.js (v20 或更高版本)
2. Git 用于版本控制
3. GitHub CLI - 从 cli.github.com 安装

设置步骤

1. Fork 并克隆存储库

   # Fork the repository (this will also clone it locally)
   gh repo fork continuedev/continue
   cd continue/docs
   
2. 安装依赖项

   npm install
   
3. 启动本地开发服务器

   npm run dev
   
   您的文档将可在 https://:3000 访问

💬 创建讨论与议题

发起讨论

议题升级流程

• 直接在讨论中提供解决方案或澄清
• 要求补充信息或进行测试
• 如果涉及代码更改或已确认是 bug，则将讨论转换为议题
• 如果问题已解决或无操作价值，则关闭讨论

何时将讨论转为议题

• 确认了文档中的 bug
• 批准了新功能或重大的文档更改
• 社区共识支持所提议的更改
• 需要技术实施

🤖 使用 Continue 进行 AI 辅助文档编写

选项 1：使用预构建的文档 Agent（推荐）

# Install the Continue CLI if you haven't already
npm install -g @continuedev/cli

# Use the agent from the command line
cn "Create a new guide for using the Continue CLI with Linear" --config continuedev/docs-mintlify

选项 2：创建您自己的自定义 Agent

# Install the Continue CLI if you haven't already
npm install -g @continuedev/cli

# Use your agent from the command line
cn --config your-org/your-agent-name "Create a new guide for API authentication"

📝 文档标准

Mintlify 组件指南

卡片和信息框

<Card title="Best Practice" icon="lightbulb">

Always include blank lines and proper indentation:

- Use 2-space indentation
- Add blank lines after opening tags
- Format lists as bullet points

</Card>

警告和提示组件

<Warning>

Important information should be formatted clearly:

- Each point on its own line
- Consistent indentation
- Clear, concise language

</Warning>

写作风格

1. 简洁明了：快速切入重点
2. 使用示例：展示成果，不仅是描述
3. 包含代码块：提供可运行的示例
4. 添加视觉内容：截图和图表有助于理解
5. 测试您的更改：确保所有链接和代码示例均能正常工作

🔧 常见任务

添加新指南

1. 在 guides 目录中创建一个新的 .mdx 文件
2. 添加 frontmatter

   ---
   title: "Your Guide Title"
   description: "Brief description of what this guide covers"
   ---
   
3. 使用 Continue Agent 辅助格式化您的内容
4. 更新 docs.json 以将新页面包含在导航中

更新现有文档

1. 使用 Continue Agent 并配合如下提示词：
   • "使用新的 npm 包更新安装指南"
   • "添加针对连接问题的故障排除部分"
2. Agent 将自动保持格式一致性

添加代码示例

```typescript
// Your TypeScript code here
const example = "Hello, Continue!";
```

🐛 测试您的更改

1. 本地预览：在 docs 目录下运行 npm run dev 并检查您的更改
2. 链接验证：确保所有内部和外部链接均有效
3. 格式检查：使用 Continue Agent 验证 Mintlify 格式
4. 构建测试：运行 npm run build 以确保没有构建错误

📤 提交您的贡献

1. 创建功能分支

   git checkout -b docs/your-feature-name
   
2. 提交您的更改

   git add .
   git commit -m "docs: describe your changes"
   
3. 推送并创建 Pull Request

   # Push to your fork and create a PR
   git push origin docs/your-feature-name
   gh pr create --web
   

将 PR 与议题关联

• closes #issue_number
• fixes #issue_number
• resolves #issue_number

Improved the installation guide with clearer steps for Windows users.

Closes #1234

💡 成功秘诀

• 使用 Continue Agent：它熟悉我们的文档标准，能节省您的时间
• 频繁预览：在本地开发服务器中检查您的更改
• 提出问题：如果需要澄清，请开启议题或讨论
• 小 PR 更好：每个 PR 专注一个主题或修复
• 更新示例：确保代码示例反映最新的 API

🆘 获取帮助

• 发起讨论：使用 GitHub Discussions 提出文档问题、建议或询问
• 关于 Continue Agent 的问题：请查看 Continue Mission Control 页面
• GitHub Discussions：加入 GitHub Discussions 获取社区帮助
• 参考现有文档：查看类似页面的格式示例