docs(readme): surface live example report links#1065
Merged
Conversation
The self-scan reports are the fastest way for a new reader to see what bca actually produces, but the README rewrite in ec8184c folded the top-level "Live example reports" section into the CI section, leaving the links roughly a hundred lines down the page. Add a labelled link pair (HTML hotspot report, Markdown report) directly after the feature bullets in both READMEs, above the fold. The CI section keeps its copy of the URLs, where they document what the pages workflow publishes. The Japanese README marks the pair as English-only, since the reports are published at /reports/ rather than under /ja/.
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
1 participant
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.
What
Restores prominent links to the live example reports in
README.mdand
README.ja.md, adding a labelled link pair directly after thefeature bullets:
Why
Those URLs were not lost, but the README rewrite in
ec8184c2foldedthe top-level
## Live example reportssection into## Quality gates and reports in CI, pushing them roughly a hundredlines down the page. They are the fastest way for a new reader to see
what the analysis actually looks like, so they belong above the fold.
The CI section keeps its copy of the URLs — there they document what
.github/workflows/pages.ymlpublishes, which is a different reader'squestion.
README.ja.mdgets the same pair, marked 「（英語）」: the reports arepublished at
/reports/, not under/ja/, so they are English-only.Validation
rumdl check README.md README.ja.md— clean.CHANGELOG.mdentry (matching howec8184c2was handled).