Skip to content

Add bilingual docs summaries#78

Merged
Pigbibi merged 1 commit into
mainfrom
codex/bilingual-docs-20260601
May 31, 2026
Merged

Add bilingual docs summaries#78
Pigbibi merged 1 commit into
mainfrom
codex/bilingual-docs-20260601

Conversation

@Pigbibi

@Pigbibi Pigbibi commented May 31, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add bilingual summary entry points to repository documentation.
  • Keep existing detailed docs intact while adding Chinese or English summaries where missing.
  • Add cross-language navigation for paired English / zh-CN docs where available.

Validation

  • Custom bilingual coverage scan: coverage_issues=0.
  • git diff --check passed.

Deployment note

Documentation-only change; no runtime code, secrets, production env, or deployment settings changed.

@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: 1e53fe35ff

ℹ️ 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
- 主要覆盖:`What This Repository Is`、`Repository Workflow`、`Strategy Plugins`、`Package Layout`、`Development`。
- 阅读顺序:先确认边界、输入输出和权限要求,再执行文档里的命令、CI、dry-run、发布或切换步骤。
- 风险提示:涉及实盘、密钥、权限、Cloud Run、交易所或券商 API 的变更,必须先在测试环境或 dry-run 验证;不要只凭示例直接修改生产。
- 英文正文保留更完整的命令、字段名和配置键;如果摘要和正文不一致,以正文中的实际命令和配置为准。

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 Insert blank lines after summary lists

On GitHub/CommonMark, when a nonblank line follows a list item without an intervening blank line, that line is treated as a lazy continuation of the list item. In this README, the repository description is therefore rendered inside the final summary bullet instead of as the intro paragraph; the same pattern appears in CONTRIBUTING.md, SECURITY.md, docs/platform_notification_outcomes*.md, docs/platform_repo_boundaries.md, docs/quantconnect.md, and the strategy-plugin link. Add a blank line after the last summary bullet before resuming the original body/link so the bilingual summaries do not absorb the document content.

Useful? React with 👍 / 👎.

@Pigbibi Pigbibi merged commit 79744dc into main May 31, 2026
1 check passed
@Pigbibi Pigbibi deleted the codex/bilingual-docs-20260601 branch May 31, 2026 19:57
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