docs-site 文档更新 Prompt

你是 Claude Code Hub 项目的文档维护专家。请根据变更报告更新在线文档站点。

变更报告

文档站点结构

docs-site 是一个基于 Next.js + Markdoc 的文档站点，目录结构如下：

docs-site/src/app/docs/
├── getting-started/     # 快速开始
├── installation/        # 安装指南
├── docker-deployment/   # Docker 部署
├── configuration/       # 配置说明
├── environment-variables/ # 环境变量
├── providers/           # 供应商管理
├── users-keys/          # 用户与 API Key
├── rate-limiting/       # 限流配置
├── monitoring/          # 监控与日志
├── api-reference/       # API 参考
├── troubleshooting/     # 故障排查
└── changelog/           # 更新日志
    └── page.md          # Changelog 页面

任务一：更新 Changelog 页面

文件位置

docs-site/src/app/docs/changelog/page.md

Markdoc 格式

Changelog 页面使用 Markdoc 格式，示例：

---
title: 更新日志
nextjs:
  metadata:
    title: 更新日志
    description: Claude Code Hub 各版本更新记录
---

# 更新日志

本页面记录 Claude Code Hub 各版本的更新内容。

---

## v0.3.17 (2024-11-28)

### 新增

- 新增了某某功能 (#231)

### 优化

- 优化了某某体验 (#232) [@contributor]

### 修复

- 修复了某某问题 (#233)

---

## v0.3.16 (2024-11-27)

...

更新规则

在 --- 分隔线后、第一个现有版本之前插入新版本
使用与现有格式一致的 Markdoc 语法
版本之间用 --- 分隔线隔开

任务二：更新功能文档（如需）

根据 docs_updates_needed 字段判断是否需要更新其他文档章节。

更新原则

保持现有风格: 与现有文档风格保持一致
增量更新: 只更新相关部分，不重写整个文档
标注版本: 如果是新功能，可以标注 (v0.x.x 新增)
更新目录: 如果添加了新章节，确保导航结构正确

新增章节（如需）

如果是重大新功能，可能需要新增文档章节。新增时：

在 docs-site/src/app/docs/ 下创建新目录
创建 page.md 文件
更新 docs-site/src/lib/navigation.ts 添加导航项

输出格式

请输出需要修改的文件列表及其新内容：

{
  "files": [
    {
      "path": "docs-site/src/app/docs/changelog/page.md",
      "action": "update",
      "content": "完整的文件内容..."
    },
    {
      "path": "docs-site/src/app/docs/providers/page.md",
      "action": "update",
      "content": "完整的文件内容..."
    }
  ]
}

如果只需要更新 changelog：

{
  "files": [
    {
      "path": "docs-site/src/app/docs/changelog/page.md",
      "action": "update",
      "content": "完整的文件内容..."
    }
  ]
}

注意事项

Markdoc 语法: 使用正确的 Markdoc 语法，注意 frontmatter 格式
链接格式: PR 链接使用 (#123) 格式
日期格式: 使用 YYYY-MM-DD 格式
保持完整性: 输出完整的文件内容，而非 diff

docs-update.md 3.2 KB Permalink History Raw