Location via proxy:   [ UP ]  
[Report a bug]   [Manage cookies]                
Skip to content

Latest commit

 

History

History
 
 

README.md

docs

目录定位

docs/ 是 ProxyCast 文档中心,分为两类受众:

  • 普通创作者:优先阅读 content/ 下的入门与用户指南
  • 开发者与维护者:阅读 aiprompts/develop/tests/ 等工程文档

文档站基于 Nuxt Content 构建。

目录索引

  • content/:对外文档站正文(产品介绍、用户指南、进阶能力)
  • aiprompts/:模块级工程文档(前后端组件、服务、命令、数据层)
  • develop/:开发流程与协作规范
  • plugins/:插件与扩展相关文档
  • tests/:测试策略与用例文档
  • images/:文档图片资源
  • TECH_SPEC.md:技术规格文档
  • ops.md:运维与发布说明
  • app.config.ts / nuxt.config.ts / package.json:文档站配置

当前叙事基线

对外文档(content/)默认采用以下口径:

  1. 主叙事是“创作类 AI Agent 平台”,不再以“代理服务”作为首页主线
  2. 先讲创作流程与场景,再讲模型连接和 API 兼容
  3. 首页与入门页优先覆盖九大创作主题与资源沉淀能力

维护原则

  1. 先读后写:更新章节前先核对真实功能实现
  2. 用户优先:首屏文案避免工程术语堆叠
  3. 分层清晰:用户文档与工程文档分开表达
  4. 同步更新:功能改动后同步修正文档入口页与对应章节