Skip to content

docs: add bilingual streamlined README and support code - #25

Merged
superche merged 2 commits into
mainfrom
feat/readme-support-20260728
Jul 28, 2026
Merged

docs: add bilingual streamlined README and support code#25
superche merged 2 commits into
mainfrom
feat/readme-support-20260728

Conversation

@superche

@superche superche commented Jul 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • replace the 581-line root README with a focused 193-line English landing page
  • add a matching 193-line Simplified Chinese README at README.zh-CN.md, with language switching links in both files
  • organize both versions around installation, first use, integration choices, architecture, local development, and documentation navigation
  • route implementation details to the existing architecture, integration, package, OpenAPI, and release-engineering sources
  • add a support section with the provided Buy Me a Coffee QR code

Impact

The repository now has concise English and Chinese entry points that are faster to scan and less likely to become stale. Runtime behavior and public contracts are unchanged.

Validation

  • git diff --check
  • verified both README files contain matching sections and 193 lines
  • verified every new local README link resolves to an existing file
  • verified assets/buy-me-a-coffee.jpg is a valid 1152×1152 JPEG

Full code tests were not run because this PR changes documentation and a static image only.

@superche superche changed the title docs: streamline README and add support code docs: add bilingual streamlined README and support code Jul 28, 2026
@superche
superche marked this pull request as ready for review July 28, 2026 12:33
@superche
superche merged commit 1874982 into main Jul 28, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant