Skip to content

docs: split bilingual open-source readmes - #131

Merged
Pigbibi merged 1 commit into
mainfrom
codex/split-bilingual-readmes-20260603
Jun 3, 2026
Merged

docs: split bilingual open-source readmes#131
Pigbibi merged 1 commit into
mainfrom
codex/split-bilingual-readmes-20260603

Conversation

@Pigbibi

@Pigbibi Pigbibi commented Jun 3, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • replace the mixed-language README with an English-only open-source entry point
  • add a separate Chinese README.zh-CN.md with the same project overview structure
  • include explicit risk notices, quick start, deployment guidance, and evidence boundaries

Validation

  • verified README.md contains no Chinese characters
  • verified README.zh-CN.md exists and contains the Chinese risk notice
  • verified only README.md and README.zh-CN.md changed

@Pigbibi
Pigbibi merged commit 7ade620 into main Jun 3, 2026
@Pigbibi
Pigbibi deleted the codex/split-bilingual-readmes-20260603 branch June 3, 2026 09:17

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 61c9743d1a

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
python scripts/print_strategy_switch_env_plan.py --profile hk_listed_global_etf_rotation --account-region hk --dry-run-only --deployment-selector hk-verify --account-scope hk-verify --service-name longbridge-quant-hk-verify-service --json
gh workflow run sync-cloud-run-env.yml --repo QuantStrategyLab/LongBridgePlatform -f target=hk-verify -f cloud_run_region=<gcp-region> -f cloud_run_service=longbridge-quant-hk-verify-service -f longport_secret_name=longport_token_hk -f longport_app_key_secret_name=longport-app-key-hk -f longport_app_secret_secret_name=longport-app-secret-hk -f deploy_image=true -f sync_env=true
python -m pip install -r requirements.txt
python -m pytest -q

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Badge Add the test runner to the fresh-clone setup

In a fresh clone, the preceding command installs only requirements.txt, but that file does not include pytest while CI installs it separately before running the suite. As written, users in a clean Python environment will hit No module named pytest at this step instead of running tests; the mirrored Chinese quick start has the same issue. Please either install pytest here or use the repository's unittest command from CONTRIBUTING.md.

Useful? React with 👍 / 👎.

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