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.
1.5 KiB
1.5 KiB
DS2API Documentation Index
To reduce maintenance drift, docs are split into an "entry doc + topical docs" layout.
Recommended reading order:
- Project overview (README)
- Architecture and project layout
- API reference
- Deployment guide
- Testing guide
- Contributing guide
Topical docs
- API -> pure-text web-chat compatibility pipeline
- Tool-calling unified semantics
- DeepSeek SSE behavior notes (reverse-engineered)
Maintenance conventions
- Documentation updates must be grounded in the actual implementation: root routing lives in
internal/server/router.go, protocol/resource routes live ininternal/httpapi/*/**/routes.goandinternal/httpapi/admin/handler.go, config defaults ininternal/config/*, models/aliases ininternal/config/models.go, and the prompt compatibility pipeline in the code entrypoints listed bydocs/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.