Repository navigation
docs: rewrite project documents in ASD-STE100 English, add screenshots - #133
Merged
Merged
Conversation
- README.md is now English with screenshots; the Chinese README moves to README.zh-CN.md. - Rewrite CONTRIBUTING, SECURITY, THIRD_PARTY_NOTICES, docs/ and scripts/README in short, plain English. - Translate the issue and PR templates. - Fix stale facts: supported versions, release assets, CI API matrix, switch size, voice pipeline. - Remove finished internal notes: REPAIR_PLAN, BETA4_VOICE, REFERENCE_IME_GUIDE, CHANGELOG_PRE_1.0, MAPPING (capability table moves to ARCHITECTURE). - CHANGELOG.md entries stay Chinese; only a link to a removed file is dropped. Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
# Conflicts: # docs/RELEASE.md
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.
Summary
README.mdis now English, with a screenshot table. The Chinese README moves toREADME.zh-CN.md.CONTRIBUTING,SECURITY,THIRD_PARTY_NOTICES,docs/andscripts/README.mdin short, plain English (ASD-STE100 style).docs/images/(keyboards and app screens, light and dark), taken from the current debug build.Stale facts fixed
SECURITY.mdnamed "the latest 1.x release"; it now names the latest release.SHA256SUMS.txt; releases attach only the APK, and the checksum is in the notes.Removed
docs/REPAIR_PLAN.md,docs/BETA4_VOICE.md,docs/REFERENCE_IME_GUIDE.md,docs/CHANGELOG_PRE_1.0.md,docs/MAPPING.md.They are finished internal plans or release-specific notes. The capability table from
MAPPING.mdmoves todocs/ARCHITECTURE.md. Git history keeps all of them.Not changed
CHANGELOG.mdentries stay Chinese (release notes, parsed byrelease_check.py). Only the link to the removed pre-1.0 file is dropped.scripts/release_build.shstill generates Chinese release notes. That is code, not documentation.Verification
python3 scripts/release_check.py checkandpython3 -m unittest discover -s scripts -p 'test_*.py'No code changes, so the unit tests and lint are not affected.
🤖 Generated with Claude Code