docs: add architecture docs and centralize documentation index; update READMEs and API links#236
Merged
CJackHwang merged 1 commit intodevfrom Apr 7, 2026
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Description
docs/ARCHITECTURE.mdanddocs/ARCHITECTURE.en.mdas the developer-facing source of truth for project layout and request flow.docs/README.mdand updated multiple topical docs underdocs/includingTESTING.md,DEPLOY.md/DEPLOY.en.md,toolcall-semantics.md, and DeepSeek SSE notes to include navigation links to the new architecture and API pages.README.MD,README.en.md,API.md, andAPI.en.mdto add cross-links to the new docs and to clarify doc navigation.docs/CONTRIBUTING.mdanddocs/CONTRIBUTING.en.mdby removing the duplicated project-structure block and replacing it with references to the newdocs/ARCHITECTURE*.mdand doc index.Testing
Codex Task