移动文件: - Caddyfile → docs/deployment/Caddyfile - fix-caddy-permissions.sh → docs/deployment/fix-caddy-permissions.sh 删除无用文件: - 根目录 package.json (空项目文件) - 根目录 bun.lock (无用锁定文件) - 根目录 node_modules/ (无用依赖目录) 保留文件: - lint-staged.config.js (项目级 pre-commit 配置) 更新引用: - 更新 caddy-setup.md 中的文件路径 - 更新 deployment/README.md 文档结构 现在根目录更干净,部署相关文件统一在 docs/deployment/ 目录下
产品文档
本目录包含摄影作品集项目的完整产品文档。
文档结构
📐 Design(设计文档)
- UI/UX 设计规范
- 组件设计系统
- 交互设计文档
- 品牌指南和视觉规范
🔌 API(API 文档)
- API 接口文档
- 数据结构定义
- 接口调用示例
- 错误码说明
👥 User Guide(用户指南)
- 用户操作手册
- 功能使用说明
- 常见问题解答
- 最佳实践指南
🛠️ Development(开发文档)
- 开发环境搭建
- 代码规范和约定
- 开发工作流程
- 测试指南
🚀 Deployment(部署文档)
- 部署配置说明
- 环境变量配置
- 服务器配置要求
- 部署流程和脚本
文档维护
请在相应的子目录中维护各类文档,确保文档的及时更新和准确性。
贡献指南
- 在相应目录下创建或更新文档
- 使用 Markdown 格式编写
- 确保文档结构清晰、内容准确
- 添加适当的图片和示例代码