Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 91 additions & 0 deletions docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -191,6 +191,97 @@
]
}
]
},
{
"language": "cn",
"tabs": [
{
"tab": "指南",
"groups": [
{
"group": "入门指南",
"pages": [
"docs/cn/index",
"docs/cn/quickstart",
"docs/cn/development"
]
},
{
"group": "自定义",
"pages": [
"docs/cn/essentials/settings",
"docs/cn/essentials/navigation"
]
},
{
"group": "撰写内容",
"pages": [
"docs/cn/essentials/markdown",
"docs/cn/essentials/code",
"docs/cn/essentials/images",
"docs/cn/essentials/reusable-snippets"
]
},
{
"group": "AI 工具",
"pages": [
"docs/cn/ai-tools/cursor",
"docs/cn/ai-tools/claude-code",
"docs/cn/ai-tools/windsurf"
]
},
{
"group": "实现练习",
"pages": [
"docs/cn/implementation-exercises/signed-webhooks",
"docs/cn/implementation-exercises/async-export-jobs",
"docs/cn/implementation-exercises/team-feature-flags"
]
}
]
},
{
"tab": "API 参考",
"groups": [
{
"group": "API 文档",
"pages": [
"docs/cn/api-reference/introduction"
]
},
{
"group": "OpenAPI 参考测试",
"pages": [
"docs/cn/api-reference/openapi-test/index",
"docs/cn/api-reference/openapi-test/relative",
"docs/cn/api-reference/openapi-test/absolute",
"docs/cn/api-reference/openapi-test/same-dir",
"docs/cn/api-reference/openapi-test/remote"
]
},
{
"group": "端点示例",
"pages": [
"docs/cn/api-reference/endpoint/get",
"docs/cn/api-reference/endpoint/create",
"docs/cn/api-reference/endpoint/delete",
"docs/cn/api-reference/endpoint/webhook",
"docs/cn/api-reference/endpoint/search",
"docs/cn/api-reference/endpoint/change-location",
"docs/cn/api-reference/endpoint/hierarchy",
"docs/cn/api-reference/endpoint/get-asset-proof",
"docs/cn/api-reference/endpoint/get-pots"
]
},
{
"group": "AsyncAPI 文档",
"asyncapi": {
"source": "docs/api-reference/asyncapi.json"
}
}
]
}
]
}
],
"global": {
Expand Down
76 changes: 76 additions & 0 deletions docs/cn/ai-tools/claude-code.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
title: "Claude Code 设置"
description: "为你的文档工作流配置 Claude Code"
icon: "asterisk"
---

Claude Code 是 Anthropic 官方的命令行工具。本指南将帮助你设置 Claude Code,以协助你编写和维护文档。

## 前置条件

- 已激活的 Claude 订阅(Pro、Max 或 API 访问权限)

## 设置

1. 全局安装 Claude Code:

```bash
npm install -g @anthropic-ai/claude-code
```

2. 进入你的文档目录。
3. (可选)将下方的 `CLAUDE.md` 文件添加到你的项目中。
4. 运行 `claude` 启动。

## 创建 `CLAUDE.md`

在你的文档仓库根目录创建一个 `CLAUDE.md` 文件,以便让 Claude Code 学习你具体的文档规范:

````markdown
# Mintlify 文档

## 协作关系
- 你可以对想法提出不同意见——这有助于产出更好的文档。当你这样做时,请引用来源并解释你的理由
- 始终请求澄清,而不是做出假设
- 永远不要撒谎、猜测或编造信息

## 项目背景
- 格式:带 YAML frontmatter 的 MDX 文件
- 配置:docs.json 用于导航、主题和设置
- 组件:Mintlify 组件

## 内容策略
- 适度记录以确保用户成功——不多不少
- 优先保证信息的准确性和可用性
- 尽可能让内容保持长期有效
- 添加新内容前先搜索现有信息。除非出于战略原因,否则避免重复
- 检查现有模式以保持一致性
- 从最小合理的改动开始

## 页面 frontmatter 要求
- title:清晰且描述性的页面标题
- description:用于 SEO 和导航的简明摘要

## 写作规范
- 使用第二人称(“你”)
- 在程序性内容开头列出前置条件
- 发布前测试所有代码示例
- 与现有页面的风格和格式保持一致
- 同时包含基础和进阶用例
- 所有代码块都加上语言标签
- 所有图片都加上替代文本
- 内部链接使用相对路径

## Git 工作流
- 提交时永远不要使用 --no-verify
- 在开始之前询问如何处理未提交的更改
- 当没有明确的分支可用于改动时,创建新分支
- 在开发过程中频繁提交
- 永远不要跳过或禁用 pre-commit 钩子

## 切勿
- 在任何 MDX 文件中省略 frontmatter
- 内部链接使用绝对 URL
- 包含未测试的代码示例
- 做出假设——务必请求澄清
````
Loading