Skip to content

docs: split bilingual open-source readmes#13

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

docs: split bilingual open-source readmes#13
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 07bcc49 into main Jun 3, 2026
@Pigbibi Pigbibi deleted the codex/split-bilingual-readmes-20260603 branch June 3, 2026 09:20
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: 311bfd6c0f

ℹ️ 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

```bash
python scripts/validate_latest_signal.py examples/latest_signal.example.json
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 Restore the test extra in the quick start

For the documented fresh-clone flow, python -m pip install -e . installs no test runner because pyproject.toml keeps pytest only under the optional test extra, while tests/test_signal_validation.py imports it. In a clean environment the very next command, python -m pytest -q, can fail with No module named pytest; the previous -e '.[test]' form avoided that.

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