docs: split bilingual open-source readmes#3
Conversation
There was a problem hiding this comment.
💡 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".
| From a fresh clone: | ||
|
|
||
| ```bash | ||
| python -m pip install -e . |
There was a problem hiding this comment.
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 👍 / 👎.
| ``` | ||
| - 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. |
There was a problem hiding this comment.
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 👍 / 👎.
Summary
Validation