Move upstream README mirror out of src/ into content/ - #980
Open
kitsuyui wants to merge 1 commit into
Open
Conversation
src/ is expected to hold application implementation modules, but the upstream README mirror (rendered on the homepage and checked for sync by scripts/check-readme-sync.ts) lived in the same directory. This blurs the boundary between runtime code and mirrored documentation content and forces contributors to guess which src/ files are app modules versus copied data. Move src/readme.md to content/readme.md and update every reference (src/index.tsx, src/readme-html-sanitizer.ts, scripts/check-readme-sync.ts, scripts/check-readme-sync.test.ts, scripts/check-readme-html-elements.ts, README.md, CONTRIBUTING.md) accordingly.
Code Metrics Report
Details | | main (6219157) | #980 (69b5a27) | +/- |
|---------------------|----------------|----------------|------|
| Coverage | 91.2% | 91.2% | 0.0% |
| Files | 3 | 3 | 0 |
| Lines | 114 | 114 | 0 |
| Covered | 104 | 104 | 0 |
| Code to Test Ratio | 1:0.9 | 1:0.9 | 0.0 |
| Code | 306 | 306 | 0 |
| Test | 288 | 288 | 0 |
- | Test Execution Time | 13s | 17s | +4s |Code coverage of files in pull request scope (90.9% → 90.9%)
Reported by octocov |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Why
src/is expected to hold this app's implementation modules, but theupstream README mirror (
src/readme.md, rendered on the homepage andchecked for sync by
scripts/check-readme-sync.ts) lived in the samedirectory. Mixing runtime code and mirrored documentation content in
one source root makes it harder for contributors to tell which
src/files are app modules versus copied data, and it forces the README
sync tooling to special-case a non-code file inside the app module
tree.
What changed
src/readme.mdtocontent/readme.md.src/index.tsx(the?rawimport)scripts/check-readme-sync.tsscripts/check-readme-sync.test.tsscripts/check-readme-html-elements.tsREADME.mdNo behavior changes: the README content, sync check, and HTML-element
check still operate on the same file, only its path changed.
Verification
bun test scripts/check-readme-sync.test.ts— 14 pass, 0 fail.bun scripts/check-readme-html-elements.ts— passes against therelocated file.
grepthat no remaining reference tosrc/readme.mdexists in the repository.
bun run lint) andvite buildcould not be executedin this sandbox because the platform-specific
biome/vitebinaries failed to materialize during
bun installhere; theimport path change is a mechanical rename verified via source
inspection and the passing unit/script checks above.