Skip to content

docs: add architecture docs and centralize documentation index; update READMEs and API links#236

Merged
CJackHwang merged 1 commit intodevfrom
codex/review-and-reorganize-all-md-documents
Apr 7, 2026
Merged

docs: add architecture docs and centralize documentation index; update READMEs and API links#236
CJackHwang merged 1 commit intodevfrom
codex/review-and-reorganize-all-md-documents

Conversation

@CJackHwang
Copy link
Copy Markdown
Owner

Motivation

  • Centralize architecture and module-responsibility information to avoid duplicated/mismatched documentation across README and contributing guides.
  • Provide a single source-of-truth for project layout, request flow and module boundaries for developers and contributors.
  • Surface the new docs in top-level references so onboarding and deployment docs consistently link to the architecture and API reference.

Description

  • Added the architecture reference files docs/ARCHITECTURE.md and docs/ARCHITECTURE.en.md as the developer-facing source of truth for project layout and request flow.
  • Added a documentation index docs/README.md and updated multiple topical docs under docs/ including TESTING.md, DEPLOY.md/DEPLOY.en.md, toolcall-semantics.md, and DeepSeek SSE notes to include navigation links to the new architecture and API pages.
  • Updated top-level landing files README.MD, README.en.md, API.md, and API.en.md to add cross-links to the new docs and to clarify doc navigation.
  • Simplified docs/CONTRIBUTING.md and docs/CONTRIBUTING.en.md by removing the duplicated project-structure block and replacing it with references to the new docs/ARCHITECTURE*.md and doc index.

Testing

  • No automated tests were run for this PR because the changes are documentation-only and do not modify executable code.

Codex Task

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 7, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
ds2api Ready Ready Preview, Comment Apr 7, 2026 3:51am

@CJackHwang CJackHwang merged commit 80b88b3 into dev Apr 7, 2026
3 checks passed
@CJackHwang CJackHwang deleted the codex/review-and-reorganize-all-md-documents branch April 7, 2026 03:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant