Files
omar ec598144d1
Build and Publish Image / build (push) Successful in 1m27s
chore: english-ize remaining config/UI text and scrub Vercel leftovers
Translate the index.html metadata, .dockerignore, docker-compose comments and
config.example.json comment to English, and restore placeholder credentials in
the example config. Fix the renamed SSE-doc link and TESTING anchor. Drop the
stale Vercel sync hint from the settings page and locales.
2026-06-02 22:38:10 +03:00
..

DS2API Documentation Index

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

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.