Skip to content

docs: sharpen homepage pitch and drop duplicate visuals - #3

Merged
mikehardy merged 3 commits into
mainfrom
docs/homepage-refinements
Sep 24, 2026
Merged

mikehardy merged 3 commits into
mainfrom
docs/homepage-refinements

Conversation

@mikehardy

Copy link
Copy Markdown
Collaborator

Follow-on to #2, addressing review feedback on the rendered homepage at docs.page/invertase/react-native-coverage.

What changed

Hero / heading

  • The tagline is now the H1 itself — "Code coverage for React Native — Typescript, iOS, and Android — without touching the native stuff." (was react-native-coverage). Broadened from "Native code coverage" to "Code coverage" since we also handle the TypeScript/JS side, and added Typescript to the platform list. Italics dropped from iOS and Android.
  • Removed the duplicate tagline (docs.page renders the frontmatter description as the subtitle, so the bold body line was a repeat).

Pitch flow (install → what it does)

  • Lead with install: "Install it into a dedicated test / e2e harness app (Pattern C) — never your shipping app."
  • Then what the module/CLI does, now calling out the merge and TypeScript remap: flush from the TurboModule, merge every framework's .profraw and the app binary into clean LCOV / Jacoco, and remap instrumented JS line-for-line back to TypeScript — "smoothing the rough edges of modern TypeScript development by handling the line-accurate source mapping for you."
  • Reworded the CI angle: "use it as a signal in your development loop or CI to gate development iterations or CI pass/fail."

The stray "text" block

  • The language-less arrow code-fence (Coverage.flush() → rn-coverage pull → …) rendered on docs.page as a bare code block with a text language pill + copy button. Replaced with prose across README.md, docs/index.mdx, and docs/why.mdx.

Homepage Info callout

  • Removed the New Architecture / TurboModule Info callout from the homepage. It still lives in the guides where the prerequisite matters.

Duplicate sunburst

  • Recaptured the ios/ Codecov file table with charts hidden, so the sunburst pie no longer appears in both the hero dashboard image and the show-don't-tell shot.

Verification

  • npx @docs.page/cli check → No documentation issues found.

@codecov

codecov Bot commented Sep 24, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 58.46%. Comparing base (c25c381) to head (8e329ec).

Additional details and impacted files
@@             Coverage Diff              @@
##               main       #3      +/-   ##
============================================
- Coverage     58.85%   58.46%   -0.40%     
  Complexity       15       15              
============================================
  Files            22       22              
  Lines          1016     1016              
  Branches        230      230              
============================================
- Hits            598      594       -4     
- Misses          346      348       +2     
- Partials         72       74       +2     
Flag Coverage Δ
e2e-android 81.70% <ø> (ø)
e2e-ios-dynamic 90.62% <ø> (ø)
e2e-ios-static 60.61% <ø> (-2.47%) ⬇️
unit-js 52.61% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

- Lead with the tagline as the H1 (Code coverage; Typescript, iOS, and
  Android; no italics) and drop the repeated tagline line.
- Reorder the pitch: install into a Pattern C test app first, then what
  the module/CLI does — flush, merge every framework .profraw + app
  binary into LCOV/Jacoco, remap instrumented JS line-for-line to TS.
- Reword the CI angle to "use it as a signal in your dev loop or CI to
  gate development iterations or CI pass/fail".
- Replace the language-less arrow code-fence (rendered as a stray
  'text' block on docs.page) with prose across README, index and why.
- Remove the New Arch/TurboModule Info callout from the homepage
  (it stays in the guides).
- Recapture the ios/ Codecov file table with charts hidden so the
  sunburst no longer appears twice.
The new pitch already frames coverage as a signal for your dev loop or
CI, so the adjacent CTA caption was saying the same thing twice. Keep
the Codecov dashboard image; drop the duplicate line.
Keep the hero dashboard image (the sunburst overview) and the
line-by-line Coverage.mm shot; remove the ios/ file-table screenshot
that duplicated the dashboard's tree. The ios/ Codecov link is folded
into the surrounding sentence so nothing is lost.
@mikehardy
mikehardy force-pushed the docs/homepage-refinements branch from 0a27915 to 8e329ec Compare September 24, 2026 20:23
@mikehardy
mikehardy merged commit c3f4655 into main Sep 24, 2026
10 checks passed
@mikehardy
mikehardy deleted the docs/homepage-refinements branch September 24, 2026 21:03
@mikehardy

Copy link
Copy Markdown
Collaborator Author

🎉 This PR is included in version 0.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant