Skip to content

docs: split bilingual open-source readmes#3

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

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

Conversation

@Pigbibi
Copy link
Copy Markdown
Contributor

@Pigbibi Pigbibi commented Jun 3, 2026

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 5e1ffc0 into main Jun 3, 2026
1 check passed
@Pigbibi Pigbibi deleted the codex/split-bilingual-readmes-20260603 branch June 3, 2026 09:21
Copy link
Copy Markdown

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

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: 1454fcadda

ℹ️ 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
From a fresh clone:

```bash
python -m pip install -e .
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 Install the test extra in quick start

For the documented fresh-clone path, python -m pip install -e . installs only the base project dependencies, while pytest is declared in the test optional dependency group in pyproject.toml. In a clean virtualenv the next python -m pytest -q step can therefore fail because pytest was never installed; the old README used .[test], which keeps this quick start reproducible.

Useful? React with 👍 / 👎.

Comment thread README.md
```
- Never commit API keys, broker credentials, OAuth tokens, cookies, or account identifiers.
- Run new strategies and platform changes in dry-run or paper mode before any live execution.
- Review generated orders, artifacts, and logs manually before enabling schedules.
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 Remove generated-order guidance from safety notes

This repository is documented here as a research publisher that does not place orders, and the repo guardrails require advisory outputs not to directly create orders, target quantities, or portfolio weights. Telling operators to review “generated orders” before enabling schedules suggests this project may produce order artifacts, which undermines that safety boundary; narrow this note to generated research artifacts, pages, notifications, and logs instead.

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