Skip to content

DOCUMENTATION_INDEX.md

Latest commit

 

History

History
463 lines (346 loc) · 26.9 KB

DOCUMENTATION_INDEX.md

File metadata and controls

463 lines (346 loc) · 26.9 KB
Raw

CarefreeCMS 文档索引

本文档提供了CarefreeCMS项目所有文档的快速导航。

📚 快速开始

文档 描述 路径
README 项目概述、功能介绍、快速开始 README.md
安装指南 完整的安装和部署说明 INSTALL.md
更新日志 所有版本的更新历史 CHANGELOG.md
贡献指南 如何为项目做贡献 CONTRIBUTING.md
文档索引 本文档 DOCUMENTATION_INDEX.md

🏗️ 架构与设计

文档 描述 路径
系统架构 系统整体架构设计 ARCHITECTURE.md
开发指南 开发规范和最佳实践 docs/development/DEVELOPER_GUIDE.md
部署指南 生产环境部署详细步骤 DEPLOYMENT.md
多站点指南 多站点功能使用说明 MULTI_SITE_GUIDE.md
错误处理指南 错误处理最佳实践 ERROR_HANDLING_GUIDE.md

🔧 核心功能文档

权限与安全

文档 描述 路径
权限系统 权限管理完整说明 PERMISSION_SYSTEM_COMPLETE.md
安全扫描 安全扫描功能说明 docs/features/SECURITY_SCANNING.md

内容管理

文档 描述 路径
文章版本控制 文章版本管理功能 docs/features/ARTICLE_VERSION_CONTROL.md
自定义字段和模型 自定义字段和内容模型 docs/features/CUSTOM_FIELDS_AND_MODELS.md
回收站 回收站功能说明 docs/features/RECYCLE_BIN.md
专题功能 专题功能说明 docs/features/TOPICS_FEATURE.md

媒体库 ⭐ v2.0全面升级

文档 描述 路径
媒体库API 媒体库系统完整API文档（去重、缩略图、水印、编辑） MEDIA_LIBRARY_API.md
媒体库增强 媒体库功能增强说明 MEDIA_LIBRARY_ENHANCEMENTS.md
媒体库快速开始 媒体库使用快速入门 docs/frontend/快速开始-媒体库.md

SEO功能

文档 描述 路径
SEO功能 SEO优化功能详细说明 docs/features/SEO_FEATURES.md
全文搜索 全文搜索和高级搜索功能 docs/features/全文搜索和高级搜索功能说明.md

用户与评论

文档 描述 路径
用户评论 用户评论功能说明 README_USER_COMMENT.md
前台用户系统 前台用户系统功能 docs/features/FRONT_USER_SYSTEM.md
评论系统 评论系统详细说明 docs/features/comment/COMMENT_SYSTEM.md
OAuth认证 OAuth第三方登录 docs/features/OAUTH_GUIDE.md
会员等级定时任务 会员等级自动更新 docs/features/member_level_cron.md
会员等级事件 会员等级事件使用 docs/features/member_level_event_usage.md

扩展功能

文档 描述 路径
友情链接和广告 友情链接和广告位功能 docs/features/LINKS_AND_ADS_FEATURE.md
幻灯片功能 幻灯片/轮播图功能 docs/features/SLIDER_FEATURE.md

标签功能

文档 描述 路径
标签自动创建 标签自动创建功能 docs/features/tag/TAG_AUTO_CREATE_FEATURE.md
标签功能总结 标签功能完整总结 docs/features/tag/TAG_FEATURE_FINAL_SUMMARY.md
前端标签使用 前端标签自动创建指南 docs/features/tag/TAG_AUTO_CREATE_FRONTEND_GUIDE.md

🤖 AI功能文档 ⭐ v2.0新增

文档 描述 路径
AI文章生成功能说明 AI文章生成功能介绍（106个模型，18个提供商） docs/updates/v2.0.0/AI文章生成功能说明.md
AI文章生成开发总结 AI文章生成功能开发记录 docs/updates/v2.0.0/AI文章生成功能开发总结.md
AI模型库更新报告（2025年12月） 最新AI模型库完整更新 docs/updates/v2.0.0/AI模型库完整更新报告_2025年12月.md
AI模型库更新报告（历史） 历史AI模型更新记录 docs/updates/v2.0.0/AI模型库更新报告_2025.md
AI前端使用指南 AI文章生成前端操作指南 docs/frontend/AI文章生成前端使用指南.md
AI模型多模态能力 AI模型多模态能力说明 docs/backend/database/AI模型多模态能力说明.md
AI模型文本生成属性 AI模型文本生成属性说明 docs/backend/database/AI模型文本生成属性说明.md

🏢 多站点功能文档 ⭐ v2.0新增

文档 描述 路径
多站点使用指南 多站点功能完整使用说明 MULTI_SITE_GUIDE.md
多站点使用手册 多站点功能使用手册 docs/features/MULTI_SITE_USAGE.md
多站点规划文档 多站点功能规划文档 docs/features/MULTI_SITE_PLANNING.md

📦 模板包系统文档 ⭐ v2.0新增

文档 描述 路径
模板包系统完整总结 模板包系统完整实施总结 docs/features/template/template_package_system_final_summary.md
模板包开发指南 模板包开发指南 docs/backend/TEMPLATE_PACKAGE_GUIDE.md
模板包完成报告 模板包功能完成报告 docs/features/template/template_package_completion.md
静态生成升级文档 静态生成支持模板包升级 docs/features/template/static_build_template_package_upgrade.md
静态生成升级完成 静态生成升级完成报告 docs/features/template/static_build_upgrade_completed.md

🎨 模板系统文档

模板开发

文档 描述 路径
模板开发指南 模板开发详细教程 docs/features/template/TEMPLATE_DEVELOPMENT_GUIDE.md
模板快速参考 模板标签快速查询 docs/features/template/TEMPLATE_QUICK_REFERENCE.md
模板编辑器 在线模板编辑器使用 docs/features/template/TEMPLATE_EDITOR.md
模板资源 模板资源管理 docs/features/template/TEMPLATE_ASSETS.md

Carefree标签库

文档 描述 路径
Carefree标签库完整指南 Carefree标签库详细文档 docs/carefree-taglib/CAREFREE_TAGLIB_COMPLETE_GUIDE.md
Carefree快速入门 Carefree标签快速开始 docs/carefree-taglib/CAREFREE_QUICK_START.md
Carefree快速参考 Carefree标签速查表 docs/carefree-taglib/CAREFREE_QUICK_REFERENCE_V2.md
Carefree最佳实践 Carefree标签使用最佳实践 docs/carefree-taglib/CAREFREE_BEST_PRACTICES.md
Carefree示例 Carefree标签使用示例 docs/carefree-taglib/CAREFREE_EXAMPLES.md
Carefree故障排除 Carefree标签常见问题 docs/carefree-taglib/CAREFREE_TROUBLESHOOTING.md

模板套装

文档 描述 路径
模板套装功能使用 模板套装功能说明 docs/features/template/模板套装功能使用指南.md
模板套装升级部署 模板套装升级说明 docs/features/template/模板套装升级部署说明.md
模板套装系统总结 模板套装系统完整总结 docs/features/template/template_package_system_final_summary.md

静态生成

文档 描述 路径
静态生成升级 静态生成功能升级 docs/features/template/static_build_upgrade_completed.md
静态生成多站点修复 多站点静态生成修复 docs/features/template/static_generation_multisite_fixes.md

💻 开发文档

开发规范

文档 描述 路径
开发指南 开发规范和最佳实践 docs/development/DEVELOPER_GUIDE.md
代码风格指南 代码风格规范 docs/development/CODE_STYLE_GUIDE.md
代码注释指南 代码注释规范 docs/development/CODE_COMMENTS_GUIDE.md
错误处理 错误处理最佳实践 docs/development/ERROR_HANDLING.md
单元测试指南 单元测试编写指南 docs/development/UNIT_TESTING_GUIDE.md

API文档

文档 描述 路径
API文档 API接口完整文档 docs/api/API_DOCUMENTATION.md
API性能测试 API性能测试报告 docs/api/API_PERFORMANCE_TEST.md
API设计指南 API设计规范 docs/backend/API_DESIGN_GUIDE.md
API示例 API使用示例 docs/backend/API_EXAMPLES.md

后端文档

文档 描述 路径
模板套装指南 后端模板套装开发 docs/backend/TEMPLATE_PACKAGE_GUIDE.md
移除全局配置 全局配置移除说明 docs/backend/remove_global_config_controller.md
移除全局站点URL 全局站点URL移除 docs/backend/remove_global_site_url.md
修复站点JSON错误 JSON解码错误修复 docs/backend/fix_site_json_decode_error.md

前端文档

文档 描述 路径
前端README 前端项目说明 docs/frontend/README.md
前端组件 前端组件说明 docs/frontend/README_COMPONENTS.md
媒体库集成 媒体库前端集成 docs/frontend/MEDIA_LIBRARY_INTEGRATION.md
缓存优化 前端缓存优化 docs/frontend/FRONTEND_CACHE_OPTIMIZATION.md
API迁移 前端API迁移指南 docs/frontend/FRONTEND_API_MIGRATION.md
AI权限配置 AI功能权限配置 docs/frontend/AI权限配置添加报告.md
AI文章生成使用 AI文章生成前端使用 docs/frontend/AI文章生成前端使用指南.md

📊 数据库文档

文档 描述 路径
数据库设计详细 数据库设计详细说明 docs/backend/database/DATABASE_DESIGN_DETAILED.md
数据库索引优化 数据库索引优化方案 docs/backend/database/DATABASE_INDEX_OPTIMIZATION.md
数据库优化计划 数据库优化计划 docs/backend/database/DATABASE_OPTIMIZATION_PLAN.md
数据库优化完成 数据库优化完成报告 docs/backend/database/DATABASE_OPTIMIZATION_COMPLETED.md
数据库重构总结 数据库重构完整总结 docs/backend/database/DATABASE_REFACTORING_COMPLETE_SUMMARY.md
数据库表重构进度 数据库表重构进度 docs/backend/database/DATABASE_TABLE_REFACTORING_PROGRESS.md
重复和空表报告 重复和空表清理报告 docs/backend/database/DUPLICATE_AND_EMPTY_TABLES_REPORT.md
重复日志清理 重复日志清理报告 docs/backend/database/DUPLICATE_LOGS_REMOVAL_REPORT.md
废弃表报告 数据库废弃表清理 DEPRECATED_TABLES_REPORT.md
AI模型多模态 AI模型多模态能力说明 docs/backend/database/AI模型多模态能力说明.md
AI模型文本生成 AI模型文本生成属性 docs/backend/database/AI模型文本生成属性说明.md
AI批量生成流程 AI批量生成任务流程 docs/backend/database/AI批量生成任务流程优化说明.md
权限配置 权限系统配置说明 docs/backend/database/permissions_config.md
权限更新总结 权限系统更新总结 docs/backend/database/permissions_update_summary.md
权限使用指南 权限系统使用指南 docs/backend/database/permissions_usage_guide.md
权限验证报告 权限验证测试报告 docs/backend/database/permission_verification_report.md
提示词模板变量 提示词模板变量功能 docs/backend/database/提示词模板变量功能说明.md
管理员权限补充 管理员权限补充报告 docs/backend/database/管理员权限补充报告.md
管理界面更新 管理界面更新说明 docs/backend/database/管理界面更新说明.md

🚀 部署与运维

部署文档

文档 描述 路径
部署指南 生产环境部署详细步骤 DEPLOYMENT.md
部署指南（详细） 部署详细说明 docs/deployment/DEPLOYMENT_GUIDE.md
后端环境配置 后端环境变量配置 docs/deployment/backend-env.md
前端环境配置 前端环境变量配置 docs/deployment/frontend-env.md
部署手册 部署操作手册 docs/deployment/DEPLOY.md

运维文档

文档 描述 路径
定时任务指南 定时任务配置说明 docs/features/CRON_JOB_GUIDE.md
日志查询指南 日志查询和分析 docs/features/LOG_QUERY_GUIDE.md
缓存优化总结 缓存优化详细说明 CACHE_OPTIMIZATION_SUMMARY.md
完整缓存优化 完整的缓存优化方案 FULL_CACHE_OPTIMIZATION_SUMMARY.md
查询监控指南 数据库查询性能监控 QUERY_MONITORING_GUIDE.md
CDN迁移 CDN到本地资源迁移 docs/deployment/CDN_TO_LOCAL_MIGRATION.md
本地资源指南 本地资源管理 docs/deployment/LOCAL_ASSETS_GUIDE.md

🐛 更新与修复记录

v2.0.0 更新（2025-12-01）

文档 描述 路径
系统更新总结 v2.0.0完整更新说明（AI、多站点、模板包、媒体库） docs/updates/v2.0.0/2025年12月系统更新总结.md
README和CHANGELOG更新总结 README.md和CHANGELOG.md全面更新记录 docs/updates/v2.0.0/README和CHANGELOG更新总结.md
文档整理总结 142个文档重组和整理详细记录 docs/updates/v2.0.0/文档整理总结.md
文档内容更新总结 所有文档内容更新详细记录 docs/updates/v2.0.0/文档内容更新总结.md
SiteModel批量删除修复 高危bug修复全记录（11个控制器） docs/updates/v2.0.0/SiteModel批量删除bug全面修复报告.md
SiteModel删除检查 删除操作全面检查 docs/updates/v2.0.0/SiteModel删除操作全面检查与修复报告.md
分类删除错误修复 clearCacheTag错误修复 docs/updates/v2.0.0/分类删除clearCacheTag错误修复报告.md
文章媒体追踪修复 媒体使用检测修复 docs/updates/v2.0.0/文章媒体使用追踪修复报告.md
专题API重构 RESTful规范化 docs/updates/v2.0.0/专题API重构为RESTful规范报告.md
AI文章任务删除修复 AI任务删除bug修复 docs/updates/v2.0.0/AI文章任务删除bug修复报告.md

v1.3.0 更新（2025-11-04）

文档 描述 路径
问题修复总结 v1.3.0修复总结 docs/updates/v1.3.0/问题修复总结.md
文档路径更新 文档路径更新说明 docs/updates/v1.3.0/文档路径更新总结.md

📖 用户手册

文档 描述 路径
用户手册 用户使用手册 docs/guides/USER_MANUAL.md
快速开始 快速开始指南 docs/guides/QUICK_START_ASSETS.md
故障排除 常见问题解决 docs/guides/TROUBLESHOOTING.md
多站点使用 多站点功能使用 docs/features/MULTI_SITE_USAGE.md
多站点规划 多站点功能规划 docs/features/MULTI_SITE_PLANNING.md

✅ 任务管理

文档 描述 路径
TODO列表 待办事项 TODO.md
已完成任务 已完成的任务列表 TODO_FINISHED.md
图片功能待办 图片相关功能待办 todo-image.md

🔄 其他文档

安装与配置

文档 描述 路径
安装完成说明 安装完成后的配置 INSTALLATION_COMPLETE.md

归档文档

文档 描述 路径
Agent说明 Agent功能说明（已归档） docs/archive/AGENTS.md
权限修复指南 权限修复指南（已归档） docs/archive/PERMISSION_FIX_GUIDE.md
模板资源更新 模板资源更新（已归档） docs/archive/TEMPLATE_ASSETS_UPDATE.md
用户指南 用户指南（已归档） docs/archive/user_guide.md
文件组织 文件组织说明（已归档） docs/archive/FILE_ORGANIZATION.md
测试报告 核心功能测试报告 docs/archive/reports/CORE_FEATURES_TEST_REPORT.md
实现总结 功能实现总结 docs/archive/reports/implementation_summary.md

📂 文档分类速查

按类型分类

📖 用户文档

  • README.md - 项目概述
  • INSTALL.md - 安装指南
  • DEPLOYMENT.md - 部署指南
  • CHANGELOG.md - 更新日志
  • docs/guides/USER_MANUAL.md - 用户手册
  • docs/guides/TROUBLESHOOTING.md - 故障排除

👨‍💻 开发者文档

  • ARCHITECTURE.md - 系统架构
  • docs/development/DEVELOPER_GUIDE.md - 开发指南
  • CONTRIBUTING.md - 贡献指南
  • ERROR_HANDLING_GUIDE.md - 错误处理
  • docs/development/CODE_STYLE_GUIDE.md - 代码风格
  • docs/development/UNIT_TESTING_GUIDE.md - 单元测试

🔧 功能文档

  • PERMISSION_SYSTEM_COMPLETE.md - 权限系统
  • MEDIA_LIBRARY_API.md - 媒体库API
  • MULTI_SITE_GUIDE.md - 多站点
  • docs/updates/v2.0.0/AI文章生成功能说明.md - AI功能
  • docs/features/SEO_FEATURES.md - SEO功能
  • docs/features/SECURITY_SCANNING.md - 安全功能

🎨 模板文档

  • docs/features/template/TEMPLATE_DEVELOPMENT_GUIDE.md - 模板开发
  • docs/carefree-taglib/CAREFREE_TAGLIB_COMPLETE_GUIDE.md - 标签库完整指南
  • docs/carefree-taglib/CAREFREE_QUICK_START.md - 标签库快速入门
  • docs/features/template/template_package_system_final_summary.md - 模板套装

🐛 问题修复文档

  • docs/updates/v2.0.0/2025年12月系统更新总结.md - v2.0.0更新
  • docs/updates/v2.0.0/SiteModel批量删除bug全面修复报告.md - 批量删除修复
  • docs/updates/v2.0.0/专题API重构为RESTful规范报告.md - API重构
  • docs/updates/v1.3.0/问题修复总结.md - v1.3.0修复

🚀 性能优化文档

  • CACHE_OPTIMIZATION_SUMMARY.md - 缓存优化
  • FULL_CACHE_OPTIMIZATION_SUMMARY.md - 完整缓存优化
  • QUERY_MONITORING_GUIDE.md - 查询监控
  • docs/backend/database/DATABASE_OPTIMIZATION_COMPLETED.md - 数据库优化

🔍 快速查找

我想要...

快速开始

→ 阅读 README.md 和 INSTALL.md

部署到生产环境

→ 阅读 DEPLOYMENT.md 和 docs/deployment/DEPLOYMENT_GUIDE.md

了解最新更新

→ 阅读 CHANGELOG.md 和 docs/updates/v2.0.0/2025年12月系统更新总结.md

了解AI功能

→ 阅读 docs/updates/v2.0.0/AI文章生成功能说明.md 和 docs/updates/v2.0.0/AI模型库完整更新报告_2025年12月.md

开发模板

→ 阅读 docs/features/template/TEMPLATE_DEVELOPMENT_GUIDE.md 和 docs/carefree-taglib/CAREFREE_QUICK_START.md

配置权限系统

→ 阅读 PERMISSION_SYSTEM_COMPLETE.md

使用媒体库

→ 阅读 MEDIA_LIBRARY_API.md

优化系统性能

→ 阅读 CACHE_OPTIMIZATION_SUMMARY.md 和 QUERY_MONITORING_GUIDE.md

配置多站点

→ 阅读 MULTI_SITE_GUIDE.md 和 docs/features/MULTI_SITE_USAGE.md

使用评论系统

→ 阅读 README_USER_COMMENT.md 和 docs/features/comment/COMMENT_SYSTEM.md

修复已知问题

→ 阅读 docs/updates/v2.0.0/2025年12月系统更新总结.md 中的Bug修复部分

贡献代码

→ 阅读 CONTRIBUTING.md 和 docs/development/DEVELOPER_GUIDE.md

📞 获取帮助

如果你在文档中没有找到需要的信息，可以通过以下方式获取帮助：

📝 文档贡献

如果你发现文档有错误或需要改进，欢迎提交Pull Request或Issue！

贡献文档的步骤：

  1. Fork本仓库
  2. 修改或新增文档
  3. 提交Pull Request
  4. 等待审核

文档编写规范：

  • 使用Markdown格式
  • 保持清晰的结构
  • 提供充分的示例
  • 包含必要的截图
  • 及时更新过时信息

🔄 文档更新记录

  • 2025-12-01: 重新组织文档结构，所有文档移入docs文件夹，创建清晰的分类
  • 2025-12-01: 创建文档索引，新增v2.0.0相关文档
  • 2025-11-04: 更新v1.3.0相关文档
  • 2025-10-28: 新增v1.2.0搜索功能文档
  • 2025-10-15: 创建项目初始文档

Made with ❤️ by CarefreeCMS Team © 2025