139 lines
5.3 KiB
Markdown
139 lines
5.3 KiB
Markdown
# PromptForge 文档索引
|
||
|
||
欢迎使用 PromptForge 文档！本索引将帮助您快速找到所需的文档和指南。
|
||
|
||
## 📚 核心文档
|
||
|
||
### 🚀 入门指南
|
||
- **[README.md](README.md)** - 项目介绍和快速开始
|
||
- **[INSTALLATION_GUIDE.md](INSTALLATION_GUIDE.md)** - 完整的安装指南
|
||
- **[ENV_SETUP_GUIDE.md](ENV_SETUP_GUIDE.md)** - 环境变量配置详解
|
||
- **[CORE_CONCEPTS.md](CORE_CONCEPTS.md)** - 核心概念和术语
|
||
- **[TEMPLATE_TUTORIAL.md](TEMPLATE_TUTORIAL.md)** - 创建第一个模板教程
|
||
|
||
### 🔧 配置文档
|
||
- **[CONFIGURATION.md](CONFIGURATION.md)** - 系统配置和优化
|
||
- **[DATABASE_SETUP.md](DATABASE_SETUP.md)** - 数据库设置和迁移
|
||
- **[DEEPSEEK_INTEGRATION.md](DEEPSEEK_INTEGRATION.md)** - DeepSeek API 集成
|
||
|
||
## 🎯 功能特性文档
|
||
|
||
### 核心功能
|
||
- **[TEMPLATE_MANAGEMENT_FEATURES.md](TEMPLATE_MANAGEMENT_FEATURES.md)** - 模板管理功能详解
|
||
- **[PLAYGROUND_FEATURES.md](PLAYGROUND_FEATURES.md)** - 测试台功能指南
|
||
- **[DEPLOYMENT_FEATURES.md](DEPLOYMENT_FEATURES.md)** - 部署功能说明
|
||
- **[SETTINGS_SUMMARY.md](SETTINGS_SUMMARY.md)** - 设置模块功能
|
||
|
||
### 用户系统
|
||
- **[USER_SYSTEM.md](USER_SYSTEM.md)** - 用户认证和管理系统
|
||
|
||
## 📋 项目文档
|
||
|
||
### 项目概览
|
||
- **[PROJECT_COMPLETE_SUMMARY.md](PROJECT_COMPLETE_SUMMARY.md)** - 项目完整功能总结
|
||
|
||
### 环境配置
|
||
- **[ENV_CONFIG.md](ENV_CONFIG.md)** - 环境配置说明
|
||
- **[ENV_SETUP.md](ENV_SETUP.md)** - 环境设置指南
|
||
|
||
## 🛠️ 开发工具
|
||
|
||
### 安装脚本
|
||
- **[install.sh](install.sh)** - Linux/macOS 自动化安装脚本
|
||
- **[install.bat](install.bat)** - Windows 自动化安装脚本
|
||
|
||
### 数据库脚本
|
||
- **[create-tables-final.js](create-tables-final.js)** - 数据库表创建脚本
|
||
- **[create-template-data.js](create-template-data.js)** - 测试数据创建脚本
|
||
- **[migrate-prompt-template-data.js](migrate-prompt-template-data.js)** - 数据迁移脚本
|
||
|
||
### 测试脚本
|
||
- **[test-deepseek-api.js](test-deepseek-api.js)** - DeepSeek API 测试
|
||
- **[test-db-connection.js](test-db-connection.js)** - 数据库连接测试
|
||
- **[test-user-system.js](test-user-system.js)** - 用户系统测试
|
||
- **[verify-data.js](verify-data.js)** - 数据验证脚本
|
||
|
||
## 📖 按主题分类
|
||
|
||
### 🎓 新手入门
|
||
1. **[README.md](README.md)** - 了解项目概况
|
||
2. **[INSTALLATION_GUIDE.md](INSTALLATION_GUIDE.md)** - 安装和配置
|
||
3. **[CORE_CONCEPTS.md](CORE_CONCEPTS.md)** - 学习核心概念
|
||
4. **[TEMPLATE_TUTORIAL.md](TEMPLATE_TUTORIAL.md)** - 创建第一个模板
|
||
5. **[CONFIGURATION.md](CONFIGURATION.md)** - 系统配置
|
||
|
||
### 🔧 系统配置
|
||
1. **[ENV_SETUP_GUIDE.md](ENV_SETUP_GUIDE.md)** - 环境变量配置
|
||
2. **[DATABASE_SETUP.md](DATABASE_SETUP.md)** - 数据库设置
|
||
3. **[DEEPSEEK_INTEGRATION.md](DEEPSEEK_INTEGRATION.md)** - API 集成
|
||
4. **[CONFIGURATION.md](CONFIGURATION.md)** - 高级配置
|
||
|
||
### 🎯 功能使用
|
||
1. **[TEMPLATE_MANAGEMENT_FEATURES.md](TEMPLATE_MANAGEMENT_FEATURES.md)** - 模板管理
|
||
2. **[PLAYGROUND_FEATURES.md](PLAYGROUND_FEATURES.md)** - AI 测试
|
||
3. **[DEPLOYMENT_FEATURES.md](DEPLOYMENT_FEATURES.md)** - 代码部署
|
||
4. **[SETTINGS_SUMMARY.md](SETTINGS_SUMMARY.md)** - 系统设置
|
||
|
||
### 🛠️ 开发维护
|
||
1. **[USER_SYSTEM.md](USER_SYSTEM.md)** - 用户系统
|
||
2. **[PROJECT_COMPLETE_SUMMARY.md](PROJECT_COMPLETE_SUMMARY.md)** - 项目架构
|
||
3. 各种测试和验证脚本
|
||
|
||
## 🔍 快速查找
|
||
|
||
### 按问题类型
|
||
- **安装问题**: [INSTALLATION_GUIDE.md](INSTALLATION_GUIDE.md)
|
||
- **配置问题**: [ENV_SETUP_GUIDE.md](ENV_SETUP_GUIDE.md)
|
||
- **数据库问题**: [DATABASE_SETUP.md](DATABASE_SETUP.md)
|
||
- **API 问题**: [DEEPSEEK_INTEGRATION.md](DEEPSEEK_INTEGRATION.md)
|
||
- **功能使用**: [TEMPLATE_TUTORIAL.md](TEMPLATE_TUTORIAL.md)
|
||
|
||
### 按用户类型
|
||
- **新手用户**: README.md → INSTALLATION_GUIDE.md → CORE_CONCEPTS.md → TEMPLATE_TUTORIAL.md
|
||
- **开发者**: PROJECT_COMPLETE_SUMMARY.md → CORE_CONCEPTS.md → 各种功能文档
|
||
- **管理员**: CONFIGURATION.md → DATABASE_SETUP.md → 测试脚本
|
||
|
||
## 📞 获取帮助
|
||
|
||
### 自助解决
|
||
1. 查看相关文档
|
||
2. 搜索 [GitHub Issues](https://github.com/your-username/promptforge/issues)
|
||
3. 查看 [常见问题](#常见问题)
|
||
|
||
### 社区支持
|
||
- **Discord**: [PromptForge 社区](https://discord.gg/promptforge)
|
||
- **Telegram**: [@PromptForgeSupport](https://t.me/PromptForgeSupport)
|
||
- **QQ 群**: 123456789
|
||
|
||
### 技术支持
|
||
- **邮箱**: support@promptforge.com
|
||
- **工作时间**: 周一至周五 9:00-18:00 (GMT+8)
|
||
|
||
## 🎉 开始使用
|
||
|
||
选择适合您的路径开始使用 PromptForge：
|
||
|
||
### 🚀 快速开始
|
||
1. 阅读 [README.md](README.md) 了解项目
|
||
2. 按照 [INSTALLATION_GUIDE.md](INSTALLATION_GUIDE.md) 安装
|
||
3. 学习 [CORE_CONCEPTS.md](CORE_CONCEPTS.md) 核心概念
|
||
4. 参考 [TEMPLATE_TUTORIAL.md](TEMPLATE_TUTORIAL.md) 创建模板
|
||
|
||
### 🔧 深度配置
|
||
1. 查看 [ENV_SETUP_GUIDE.md](ENV_SETUP_GUIDE.md) 配置环境
|
||
2. 阅读 [CONFIGURATION.md](CONFIGURATION.md) 优化系统
|
||
3. 探索各种功能文档
|
||
|
||
---
|
||
|
||
**提示**: 建议按照文档的推荐顺序阅读，以获得最佳的学习体验。
|
||
|
||
<div align="center">
|
||
|
||
**PromptForge** - 让 AI 提示词工程更简单
|
||
|
||
[](https://github.com/your-username/promptforge)
|
||
[](LICENSE)
|
||
|
||
</div>
|