logo
0
0
WeChat Login
refactor: 整理项目文档结构

42chat 项目文档

完整的项目文档索引和指南

📋 文档导航

🚀 部署文档

部署相关的完整指南和配置说明。

文档描述
快速开始从零到部署的最快路径
EdgeOne 部署指南EdgeOne Pages 完整部署指南
密钥仓库配置CNB 密钥仓库详细设置
CNB 配置指南CNB 构建配置完整说明

💻 开发文档

开发过程中的参考文档。

文档描述
测试指南单元测试和 E2E 测试说明

📝 模板文件

项目配置模板和示例文件。

模板描述
密钥模板CNB 密钥仓库配置模板

📦 归档文档

历史文档和初始化报告。

文档描述
初始化报告项目初始化完整报告

🎯 快速导航

新手入门

  1. 阅读 项目 README 了解项目概况
  2. 查看 CLAUDE.md 了解项目规范
  3. 按照 快速开始 部署应用

部署到生产环境

  1. EdgeOne 部署指南 - 了解部署架构
  2. 密钥仓库配置 - 配置敏感信息
  3. 快速开始 - 执行部署

开发和测试

  1. CLAUDE.md - 开发规范
  2. 测试指南 - 运行测试

📚 文档结构

docs/ ├── README.md # 本文件 - 文档索引 ├── deployment/ # 部署相关文档 │ ├── quickstart.md # 快速开始指南 │ ├── edgeone.md # EdgeOne 部署指南 │ ├── secrets.md # 密钥仓库配置 │ └── cnb.md # CNB 配置说明 ├── development/ # 开发相关文档 │ └── testing.md # 测试指南 ├── templates/ # 模板文件 │ └── secrets/ # 密钥配置模板 │ ├── README.md # 模板使用说明 │ ├── edgeone-secrets.yml # EdgeOne 密钥模板 │ ├── database-secrets.yml# 数据库密钥模板 │ └── api-keys-secrets.yml# API 密钥模板 └── archive/ # 归档文档 └── initialization.md # 初始化报告

🔗 外部资源

相关平台

API 文档

框架文档


💡 文档贡献

添加新文档

  1. 在合适的目录下创建 Markdown 文件
  2. 更新本索引文件
  3. 确保文档格式一致
  4. 提交到代码仓库

文档规范

  • 使用清晰的标题层级
  • 包含目录(如适用)
  • 添加代码示例
  • 提供实际的配置案例
  • 更新日期和版本信息

最后更新:2026-01-07 项目版本:v0.1.0