Skip to content

docs: rework the README for readers adopting the table - #115

Merged
funkadelic merged 10 commits into
mainfrom
docs/readme-theming
Oct 1, 2026
Merged

funkadelic merged 10 commits into
mainfrom
docs/readme-theming

Conversation

@funkadelic

@funkadelic funkadelic commented Oct 1, 2026 •

Copy link
Copy Markdown
Owner
  • Usage and Configuring rewritten for adopters, with the rationale moved to Design notes
  • Theming names Style Dictionary and the DTCG tokens
  • Testing is split by kind of test, with fallow, Sonar and CodeQL under static analysis, and bundle size moves under Benchmarks
  • the getRowId section is corrected
  • Internationalization moves under Features, browser support gets its own section, and data attribution moves to the end

Summary by cubic

Restructures the README without changing any code: rewrites Usage and Configuring for developers adopting the table, moves the rationale into a new Design notes section, names the Style Dictionary and DTCG token pipeline in Theming, nests Internationalization under Features, gives Browser support its own section, splits Testing into per-kind subsections with fallow, SonarCloud and CodeQL under static analysis, moves bundle size tracking under Benchmarks and data attribution to the end, and corrects the getRowId section to match the implementation.

Written for commit 488dd3b. Summary will update on new commits.

Review in cubic

@funkadelic
funkadelic marked this pull request as ready for review October 1, 2026 00:47
@funkadelic funkadelic self-assigned this Oct 1, 2026
@codecov

codecov Bot commented Oct 1, 2026

Copy link
Copy Markdown

Bundle Report

Bundle size has no change ✅

@codspeed

codspeed Bot commented Oct 1, 2026 •

Copy link
Copy Markdown
Contributor

Merging this PR will improve performance by 14.59%

⚡ 1 improved benchmark
✅ 26 untouched benchmarks
⏩ 1 skipped benchmark1

Performance Changes

Benchmark BASE HEAD Efficiency
⚡ repeat sort of 50250 cities by name (cached) 1,086.8 µs 948.4 µs +14.59%

Tip

Curious why performance improved? Comment @codspeedbot explain why performance improved on this PR, or directly use the CodSpeed MCP with your agent.


Comparing docs/readme-theming (488dd3b) with main (e07f467)

Open in CodSpeed

Footnotes

  1. 1 benchmark was skipped, so the baseline result was used instead. If it was deleted from the codebase, click here and archive it to remove it from the performance reports. ↩

@cubic-dev-ai cubic-dev-ai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

Re-trigger cubic

@codecov

codecov Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (e07f467) to head (488dd3b).
⚠️ Report is 1 commits behind head on main.
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #115   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           48        48           
  Lines          773       773           
  Branches       145       145           
=========================================
  Hits           773       773           

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

@github-actions

github-actions Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

Lighthouse, median of 3 mobile runs

Page Score FCP LCP TBT CLS Speed Index
Cities 100 1.1s 1.4s 22ms 0.000 1.1s
Films 94 1.1s 3.0s 0ms 0.000 1.1s

Full reports

@funkadelic funkadelic changed the title docs: rename Theming and split Testing in the README docs: reorganize the theming, testing and attribution sections of the README Oct 1, 2026
@funkadelic funkadelic changed the title docs: reorganize the theming, testing and attribution sections of the README docs: rework the README for readers adopting the table Oct 1, 2026
@sonarqubecloud

sonarqubecloud Bot commented Oct 1, 2026

Copy link
Copy Markdown

@funkadelic
funkadelic enabled auto-merge (squash) October 1, 2026 01:41
@funkadelic
funkadelic merged commit a847aa9 into main Oct 1, 2026
14 of 16 checks passed
@funkadelic
funkadelic deleted the docs/readme-theming branch October 1, 2026 01:42
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