mirror of
https://github.com/aiclientproxy/proxycast.git
synced 2026-09-24 23:10:56 +08:00
docs
目录定位
docs/ 是 Lime 文档中心,分为两类受众:
- 普通创作者:优先阅读
content/下的入门与用户指南 - 开发者与维护者:阅读
aiprompts/、develop/、tech/、tests/等工程文档
文档站基于 Nuxt Content 构建。
目录索引
content/:对外文档站正文(产品介绍、用户指南、进阶能力)aiprompts/:模块级工程文档(前后端组件、服务、命令、数据层)exec-plans/:执行计划、进度日志、技术债追踪tech/:跨模块技术蓝图与专题工程文档(当前已包含 Harness Engineering 指导文档)bussniss/:商务合作与代理运营方案develop/:开发流程与协作规范plugins/:插件与扩展相关文档tests/:测试策略与用例文档iteration-notes/:迭代备忘与下版本建议(暂不进入当前发布范围的问题)images/:文档图片资源TECH_SPEC.md:技术规格文档exec-plans/README.md:执行计划目录说明exec-plans/tech-debt-tracker.md:技术债持续追踪表develop/execution-tracker-technical-plan.md:统一执行追踪(Execution Tracker)专项技术规划develop/execution-tracker-deprecation-plan.md:统一执行追踪旧路径退场计划(P0 收口)develop/execution-tracker-p0-acceptance-report.md:统一执行追踪 P0 验收报告develop/execution-tracker-p1-p2-roadmap.md:统一执行追踪后续路线(P1/P2)tech/harness/README.md:Lime Harness Engineering 总入口tech/harness/implementation-blueprint.md:Lime Harness 分阶段实施蓝图develop/scheduler-task-governance-p1.md:调度任务治理 P1(连续失败、自动停用、冷却恢复)roadmap/lime-skills-standardization-roadmap.md:Skills 标准化与产品化路线图roadmap/lime-service-skill-cloud-config-prd.md:服务型技能的端优先执行与云配置同步 PRDroadmap/lime-browser-site-capability-prd.md:站点能力按真实浏览器优先接入的产品需求文档ops.md:运维与发布说明app.config.ts/nuxt.config.ts/package.json:文档站配置
当前叙事基线
对外文档(content/)默认采用以下口径:
- 主叙事是“创作类 AI Agent 平台”,不再以“代理服务”作为首页主线
- 先讲创作流程与场景,再讲模型连接和 API 兼容
- 首页与入门页优先覆盖核心工作区主题与资源沉淀能力
维护原则
- 先读后写:更新章节前先核对真实功能实现
- 用户优先:首屏文案避免工程术语堆叠
- 分层清晰:用户文档与工程文档分开表达
- 同步更新:功能改动后同步修正文档入口页与对应章节