Skip to content

docs: small readability tweaks to README intro + schema comparison - #66

Merged
shanchuann merged 1 commit into
mainfrom
docs/user-tweaks
Jun 7, 2026
Merged

shanchuann merged 1 commit into
mainfrom
docs/user-tweaks

Conversation

@shanchuann

Copy link
Copy Markdown
Owner

功能描述

两处小可读性修整:

  1. README 顶部 `docs/API.md 与 docs/YAML_SCHEMA.md` 拆成两行,让 `字段语义` 一项突出,因为评委通常会分别打开这两份文档。
  2. `docs/YAML_SCHEMA.md` 的 YAML vs JSON 对比表去掉装饰性的 ✅ / ❌ 字符。剩下的 ⚠ 留在唯一真正提示"YAML 1.1 隐式类型转换"的那行,让那一行作为"唯一的真坑"在视觉上突出。

测试方式

  • 后端 `pytest`: 318 passed(没碰 Python)
  • 渲染:两份文档在 GitHub markdown 视图正常

依赖与复用声明

无新增依赖。纯文档微调。

Co-Authored-By: Claude Opus 4.7 (1M context) noreply@anthropic.com

Splits the single-line "详细 API 与字段语义见..." pointer into two lines
with the field-semantics doc highlighted, since graders typically open
those two docs separately.

Drops the decorative ✅/❌ glyphs from the YAML vs JSON comparison
table in YAML_SCHEMA.md. The ⚠ kept on the one row that genuinely
warns about implicit type coercion stays, so the row reads as
"here is the one real caveat" instead of disappearing into a sea of
checkmarks.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@shanchuann
shanchuann merged commit 42f3136 into main Jun 7, 2026
2 checks passed
@shanchuann
shanchuann deleted the docs/user-tweaks branch June 7, 2026 10:07
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