Skip to content

docs: split bilingual open-source readmes#52

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

docs: split bilingual open-source readmes#52
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 658a714 into main Jun 3, 2026
1 check passed
@Pigbibi Pigbibi deleted the codex/split-bilingual-readmes-20260603 branch June 3, 2026 09:16

@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: c8b79f057b

ℹ️ 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
| `BINANCE_API_SECRET` | Binance API secret |
| `TG_TOKEN` | Telegram bot token |
| `GLOBAL_TELEGRAM_CHAT_ID` | Telegram chat ID for alerts. |
Configure GitHub Actions secrets/variables for Binance credentials, runtime settings, notifications, and strategy source. Run the workflow manually in dry-run mode first, review logs/artifacts, then enable the scheduled workflow only after credentials and risk controls are verified.

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 Avoid calling the Runtime workflow dry-run-capable

This line tells operators to manually run the GitHub Actions workflow in dry-run mode, but the inspected Runtime workflow only exposes validate_only in .github/workflows/main.yml, which exits after GCP/Firestore auth, and the live path constructs ExecutionRuntime(dry_run=False) in runtime_config_support.py. For an operator following the README before enabling schedules, there is no workflow dry-run to review orders/artifacts; dispatching without validate_only runs main.py against Binance credentials, so the safe pre-live instruction is misleading and should point to the actual replay command or add a workflow dry-run toggle.

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