Skip to content

docs: clean up READMEs - remove redundant sections#261

Merged
jackwener merged 1 commit intomainfrom
docs/cleanup-readme
Mar 22, 2026
Merged

docs: clean up READMEs - remove redundant sections#261
jackwener merged 1 commit intomainfrom
docs/cleanup-readme

Conversation

@jackwener
Copy link
Owner

移除两份 README 中不必要的内容,让文档更精简:

  • Table of Contents — GitHub 自动生成 TOC,手动维护容易不同步
  • Method 2: Load from npm Package — 保留推荐方式和开发者方式即可
  • Bloomberg 详细说明 — 过于细节,放 adapter 文档更合适
  • Pipeline Step YAML 示例 — 开发者内部实现细节
  • Releasing New Versions / 版本发布 — 属于 CONTRIBUTING.md 的内容
  • Testing 部分(英文版)— 精简为一行 + TESTING.md 链接

Removed from both EN/CN READMEs:
- Table of Contents (GitHub auto-generates TOC)
- Method 2: Load from npm Package (keep recommended + dev only)
- Bloomberg detailed note (too specific for README)
- Pipeline Step YAML example (developer-internal)
- Releasing New Versions (belongs in CONTRIBUTING.md)

EN README only:
- Simplified Testing section to one-liner + link to TESTING.md
@jackwener jackwener merged commit 7ebe813 into main Mar 22, 2026
11 checks passed
@jackwener jackwener deleted the docs/cleanup-readme branch March 22, 2026 14:26
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