omar
0932e16178
Remove upstream-forks.md and upstream-hefengfan0615-evaluation.md (the original maintainer's fork-tracking notes, irrelevant to this deployment) and their references in the docs index and contributing guide.
28 lines
1.5 KiB
Markdown
28 lines
1.5 KiB
Markdown
# DS2API Documentation Index
|
|
|
|
To reduce maintenance drift, docs are split into an "entry doc + topical docs" layout.
|
|
|
|
Recommended reading order:
|
|
|
|
1. [Project overview (README)](../README.MD)
|
|
2. [Architecture and project layout](./ARCHITECTURE.md)
|
|
3. [API reference](../API.md)
|
|
4. [Deployment guide](./DEPLOY.md)
|
|
5. [Testing guide](./TESTING.md)
|
|
6. [Contributing guide](./CONTRIBUTING.md)
|
|
|
|
### Topical docs
|
|
|
|
- [API -> pure-text web-chat compatibility pipeline](./prompt-compatibility.md)
|
|
- [Tool-calling unified semantics](./toolcall-semantics.md)
|
|
- [DeepSeek SSE behavior notes (reverse-engineered)](./deepseek-sse-behavior-2026-04-05.md)
|
|
|
|
### Maintenance conventions
|
|
|
|
- Documentation updates must be grounded in the actual implementation: root routing lives in `internal/server/router.go`, protocol/resource routes live in `internal/httpapi/*/**/routes.go` and `internal/httpapi/admin/handler.go`, config defaults in `internal/config/*`, models/aliases in `internal/config/models.go`, and the prompt compatibility pipeline in the code entrypoints listed by `docs/prompt-compatibility.md`.
|
|
- `README.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.
|