Skip to content

feat: add README corpus fidelity gate - #2

Merged
developer0hye merged 3 commits into
mainfrom
feat/corpus-fidelity-gate
Mar 8, 2026
Merged

feat: add README corpus fidelity gate#2
developer0hye merged 3 commits into
mainfrom
feat/corpus-fidelity-gate

Conversation

@developer0hye

Copy link
Copy Markdown
Owner

Summary

  • add the 50-repo README corpus validator, baselines, and CI workflow
  • harden shared rendering for print fidelity with sanitization, TOC, print guards, and repo-root-relative asset support
  • document and track the remaining advisory-only remote asset cases from the corpus

Why

  • the PRD fidelity goal requires automated validation against real public README inputs, not manual inspection alone
  • the corpus exposed real renderer and validator gaps that are now covered by regression tests
  • the current validated state gives us a repeatable gate for future rendering changes

Key Changes

  • add validation/readme_corpus.mjs, supporting libraries, pinned manifest, and committed baselines
  • add corpus regression coverage for badge-heavy headings and repo-root-relative README assets
  • fix local asset resolution for GitHub-style /path README image references
  • tighten source snapshot normalization for badge-heavy headings and emphasis-fragmented words
  • add the README corpus GitHub Actions workflow and supporting docs/reference notes

Verification

  • cargo fmt --all
  • node --test validation/readme_corpus.test.mjs
  • node validation/readme_corpus.mjs verify-manifest --offline
  • targeted corpus reruns for angular/angular and serde-rs/serde
  • node validation/readme_corpus.mjs bless --tier all --force
    • 50 repos
    • 0 hard failures
    • 4 advisory-only warnings

Context

The remaining advisory-only warning cases are tracked separately in issue #1.

Related: #1

Signed-off-by: Yonghye Kwon <developer.0hye@gmail.com>
Signed-off-by: Yonghye Kwon <developer.0hye@gmail.com>
Signed-off-by: Yonghye Kwon <developer.0hye@gmail.com>
@developer0hye
developer0hye merged commit 6711565 into main Mar 8, 2026
2 checks passed
@developer0hye
developer0hye deleted the feat/corpus-fidelity-gate branch March 8, 2026 23:48
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