Skip to content

docs: simplify READMEs and organize detailed guides - #551

Merged
JE-Chen merged 3 commits into
mainfrom
dev
Nov 9, 2026
Merged

JE-Chen merged 3 commits into
mainfrom
dev

Conversation

@JE-Chen

@JE-Chen JE-Chen commented Nov 9, 2026

Copy link
Copy Markdown
Member

Why

The English, Traditional Chinese and Simplified Chinese READMEs mixed getting-started information with long implementation histories and detailed contracts. Readers now see the project purpose, installation, a minimal Python example and links to further documentation.

Changes

  • Move detailed installation, usage, integration, completion-evidence and development material into language-specific guides under docs/guides.
  • Preserve historical implementation notes separately and identify them as historical rather than current acceptance status.
  • Add a documentation index and adjust relative links for the moved content.

Validation

  • Checked local file links across 24 Markdown files; no missing targets.
  • git diff --check origin/main...HEAD passes.
  • Documentation-only change; no application tests run.

@sonarqubecloud

sonarqubecloud Bot commented Nov 9, 2026

Copy link
Copy Markdown

@JE-Chen
JE-Chen merged commit c28da22 into main Nov 9, 2026
33 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