add-neon-docs
Compare original and translation side by side
🇺🇸
Original
English🇨🇳
Translation
ChineseAdd Neon Knowledge References to Project
为项目添加Neon知识参考链接
This skill adds reference links to Neon documentation and best practices in your project's AI documentation file, enabling AI assistants to quickly access Neon-specific patterns and guidelines without cluttering your project with large documentation files.
此Skill会将Neon文档和最佳实践的参考链接添加到项目的AI文档文件中，让AI助手能够快速获取Neon特定的模式和指南，同时不会让项目被大量文档文件占用。
How It Works
工作原理
This skill follows a simple workflow:
- Load metadata - Read skill information from
skill-knowledge-map.json - Detect documentation file - Find ,
CLAUDE.md, or Cursor rules filesAGENTS.md - Ask permission - Show what will be added and where
- Add references - Insert URLs in a "Resources & References" section
- Report completion - Confirm successful installation
For detailed workflow steps, see .
install-knowledge.md此Skill遵循以下简单流程：
- 加载元数据 - 从中读取Skill信息
skill-knowledge-map.json - 检测文档文件 - 查找、
CLAUDE.md或Cursor规则文件AGENTS.md - 请求权限 - 展示将要添加的内容和位置
- 添加参考链接 - 在“Resources & References”部分插入URL
- 完成报告 - 确认安装成功
如需详细的流程步骤，请查看。
install-knowledge.mdParameters
参数
SKILL_NAME Parameter
SKILL_NAME参数
Optional. Specifies which skill documentation to install (e.g., ). If not provided, you'll be prompted to choose from available skills defined in .
"neon-drizzle"skill-knowledge-map.json可选。指定要安装的Skill文档（例如）。如果未提供，系统会提示您从中定义的可用Skill中进行选择。
"neon-drizzle"skill-knowledge-map.jsonUsage Examples
使用示例
Called from another skill:
markdown
Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"Called directly by user:
- "Add neon drizzle knowledge to my project"
- "Install neon serverless documentation"
- "Set up Neon best practices for my AI assistant"
从其他Skill调用：
markdown
Execute the add-neon-docs skill with SKILL_NAME="neon-drizzle"由用户直接调用：
- "为我的项目添加Neon Drizzle知识"
- "安装Neon无服务器文档"
- "为我的AI助手设置Neon最佳实践"
What Gets Added
会添加的内容
References are added to a "Resources & References" section in your AI documentation file:
markdown
undefined参考链接会被添加到AI文档文件的“Resources & References”部分：
markdown
undefinedResources & References
Resources & References
- Neon and Drizzle ORM best practices: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-drizzle.mdc
- Serverless connection patterns: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-serverless.mdc
undefined- Neon and Drizzle ORM best practices: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-drizzle.mdc
- Serverless connection patterns: https://raw.githubusercontent.com/neondatabase-labs/ai-rules/main/neon-serverless.mdc
undefinedTarget Files (in priority order):
目标文件（优先级顺序）：
- - Most common for Claude Code projects
CLAUDE.md - - Custom AI documentation files
AGENTS.md - or
.cursor/README.md- Cursor IDE projects.cursor/rules.md - Creates if none exist
CLAUDE.md
- - Claude Code项目最常用的文件
CLAUDE.md - - 自定义AI文档文件
AGENTS.md - 或
.cursor/README.md- Cursor IDE项目文件.cursor/rules.md - 如果不存在上述文件，则创建
CLAUDE.md
Behavior:
行为说明：
- Existing "Resources & References" sections: New links are appended
- No existing section: Section is created at end of file
- No documentation file: is created with references
CLAUDE.md
- 若已存在“Resources & References”部分：新链接会被追加到该部分
- 若不存在该部分：会在文件末尾创建该部分
- 若没有文档文件：会创建包含参考链接的
CLAUDE.md
Related Skills
相关Skill
- neon-drizzle - Sets up Drizzle ORM, then offers this skill
- neon-serverless - Sets up connections, then offers this skill
- neon-toolkit - Sets up ephemeral databases, then offers this skill
- neon-drizzle - 配置Drizzle ORM后，会提供此Skill
- neon-serverless - 配置连接后，会提供此Skill
- neon-toolkit - 配置临时数据库后，会提供此Skill
Workflow Reference
流程参考
For complete implementation details:
- Workflow: - Step-by-step agent workflow with error handling
install-knowledge.md - Metadata: - Skill definitions and reference URLs
skill-knowledge-map.json
如需完整的实现细节：
- 流程文档：- 包含错误处理的分步Agent流程
install-knowledge.md - 元数据：- Skill定义和参考URL
skill-knowledge-map.json
Workflow Implementation
流程执行
Now I'll execute the installation workflow for you.
Parameter received: SKILL_NAME = ${SKILL_NAME || "not provided - will ask user"}
Execute with the specified SKILL_NAME.
install-knowledge.md现在我将为您执行安装流程。
收到的参数：SKILL_NAME = ${SKILL_NAME || "not provided - will ask user"}
使用指定的SKILL_NAME执行。
install-knowledge.md