ds2api/docs/README.md

DS2API 文档导航 | Documentation Index

语言 / Language: 中文 | English

中文

为减少重复维护，本仓库文档按“入口文档 + 专题文档”拆分。建议从下列顺序阅读：

1. 项目总览（README）
2. 架构与目录说明
3. 接口文档（API）
4. 部署指南
5. 测试指南
6. 贡献指南

专题文档

• API -> 网页对话纯文本兼容主链路说明
• Tool Calling 统一语义
• DeepSeek SSE 行为结构说明（逆向观察）

文档维护约定

• README.MD / README.en.md：面向首次接触用户，保留“是什么 + 怎么快速跑起来”。
• docs/ARCHITECTURE*.md：面向开发者，集中维护项目结构、模块职责与调用链。
• API*.md：面向客户端接入者，聚焦接口行为、鉴权和示例。
• docs/prompt-compatibility.md：面向维护者，集中维护“API -> 网页对话纯文本上下文”的统一兼容语义；相关行为修改时必须同步更新。
• 其他 docs/*.md：主题化说明，避免在多个文档重复粘贴同一段内容。

---

English

To reduce maintenance drift, docs are split into an “entry doc + topical docs” layout.

Recommended reading order:

1. Project overview (README)
2. Architecture and project layout
3. API reference
4. Deployment guide
5. Testing guide
6. Contributing guide

Topical docs

• API -> pure-text web-chat compatibility pipeline
• Tool-calling unified semantics
• DeepSeek SSE behavior notes (reverse-engineered)

Maintenance conventions

• README.MD / README.en.md: onboarding-oriented (“what + quick start”).
• docs/ARCHITECTURE*.md: developer-oriented source of truth for module boundaries and execution flow.
• API*.md: integration-oriented behavior/contracts.
• docs/prompt-compatibility.md: maintainer-oriented source of truth for the “API -> pure-text web-chat context” compatibility flow; update it whenever related behavior changes.
• Other docs/*.md: focused topics, avoid copy-pasting the same section into multiple files.