Skip to content

docs: README v0.1.7.1 — correct doc count, results table, dual-metric#24

Merged
Lawrenzho-bit merged 1 commit into
mainfrom
docs/v017-readme-update
May 21, 2026
Merged

docs: README v0.1.7.1 — correct doc count, results table, dual-metric#24
Lawrenzho-bit merged 1 commit into
mainfrom
docs/v017-readme-update

Conversation

@Lawrenzho-bit

Copy link
Copy Markdown
Owner

Changes

  • Fix wrong doc count: "200 documents" → 59 documents (v0.1.7; v0.2 target was aspirational)
  • Fix stale comment: "v0.1 ships 5 samples" → 59-doc index (v0.1.7)
  • Remove unimplemented claim: "held-out split rotated quarterly"
  • Add Current results table (v0.1.7.1 chrF · oracle-layout) — the first thing any reviewer looks for
  • Add dual-metric note (chrF + COMET-Kiwi) with key finding on COMET–chrF gap
  • Update repository layout block to reflect three data subdirs (annotations/, flores_derived/, rileykim_derived/)
  • Update license section to mention CC-BY-SA-4.0 for FLORES-derived docs
  • Link methodology-roadmap.md from metrics section

Test plan

  • CI passes
  • README renders correctly on GitHub (especially the results table and code blocks)

🤖 Generated with Claude Code

@Lawrenzho-bit Lawrenzho-bit merged commit a98b328 into main May 21, 2026
3 checks passed
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