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 官方的 CLI 工具。本指南将帮助您设置 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 documentation

## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information

## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- Components: Mintlify components

## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Make content evergreen when possible
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes

## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation

## Writing standards
- Second-person voice ("you")
- Prerequisites at start of procedural content
- Test all code examples before publishing
- Match style and formatting of existing pages
- Include both basic and advanced use cases
- Language tags on all code blocks
- Alt text on all images
- Relative paths for internal links

## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
- Create a new branch when no clear branch exists for changes
- Commit frequently throughout development
- NEVER skip or disable pre-commit hooks

## Do not
- Skip frontmatter on any MDX file
- Use absolute URLs for internal links
- Include untested code examples
- Make assumptions - always ask for clarification
````
Loading