Skip to content

docs: synchronize English and Chinese READMEs - #70

Merged
Pigbibi merged 1 commit into
mainfrom
docs/readme-configuration-sync
Oct 16, 2026
Merged

Pigbibi merged 1 commit into
mainfrom
docs/readme-configuration-sync

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Documentation-only: synchronize the English and Simplified Chinese READMEs with the organization documentation style guide.

Why

The Chinese README lacked configuration and HTTP endpoint details. Both guides needed the standard section order and language links.

Changes

  • Use matching sections, commands, configuration tables, and HTTP endpoint references in both languages.
  • Explain local input handling, profile selection, and the existing offline dry-run and paper-admission behavior.
  • Replace the fixed digest example with a placeholder and add contribution, security, and license links.

Testing

Passed git diff --check and static checks for local links, command paths, balanced Markdown fences, Bash syntax, matching bilingual sections and command blocks, and added-content privacy patterns. Verified the documented settings, routes, and lifecycle behavior against the current implementation. No runtime tests were run locally because only the two README files changed. CI: test workflow.

Risk and rollback

Documentation-only change. Revert the commit to restore the previous README text.

Breaking changes

none

Checklist

Co-Authored-By: Codex <noreply@openai.com>
@Pigbibi
Pigbibi marked this pull request as ready for review October 16, 2026 13:08
@Pigbibi
Pigbibi merged commit a7ca76e into main Oct 16, 2026
1 check passed
@Pigbibi
Pigbibi deleted the docs/readme-configuration-sync branch October 16, 2026 13:08
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