Repository navigation
docs: align bilingual README and retain CLI reference - #39
Merged
Merged
Conversation
Co-Authored-By: Codex <noreply@openai.com>
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
Documentation only: align the English and Simplified Chinese READMEs and move the existing detailed command examples into a linked CLI reference.
Why
The English README mixed the project overview with a long command reference, while the Chinese README omitted most setup and usage information.
Changes
docs/cli-reference.md, organized by topic.Testing
git diff --cached --check: passed before commit.list_signal_source_families --prettyandlist_consumer_contracts --pretty: returned valid JSON.build_btc_cycle_bundle --help: every README configuration option exists.The full code test suite was not run locally for this documentation-only change. The existing source CI runs automatically on the PR.
Risk and rollback
Documentation only; no code, dependency, configuration, or workflow changes. Revert the documentation commit if needed.
Breaking changes
none