Skip to content

docs: remove duplicated project structure sections from READMEs#238

Merged
CJackHwang merged 1 commit intodevfrom
codex/remove-project-structure-section-from-main-document
Apr 7, 2026
Merged

docs: remove duplicated project structure sections from READMEs#238
CJackHwang merged 1 commit intodevfrom
codex/remove-project-structure-section-from-main-document

Conversation

@CJackHwang
Copy link
Copy Markdown
Owner

Motivation

  • The main README files included a duplicated "项目结构" / "Project Structure" section that duplicates the authoritative architecture docs in docs/ARCHITECTURE.md and docs/ARCHITECTURE.en.md.
  • Remove the duplicated block to keep the top-level README focused on onboarding and to avoid split maintenance of project structure information.

Description

  • Delete the ## 项目结构 block from README.MD and the ## Project Structure block from README.en.md so the README delegates structure details to docs/ARCHITECTURE*.md.
  • Preserve surrounding content and the documentation index so the READMEs still provide onboarding and links to detailed docs.

Testing

  • No automated tests were run because this is a documentation-only change and does not affect runtime code.
  • Performed quick verification that the removed sections no longer appear by searching the READMEs and inspecting the resulting diffs (rg/git diff).

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 4:33am

@CJackHwang CJackHwang merged commit 4475bfe into dev Apr 7, 2026
3 checks passed
@CJackHwang CJackHwang deleted the codex/remove-project-structure-section-from-main-document branch April 7, 2026 04:36
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