Rewrote the README feature, field and theme sections as scannable lists and sections. - #160
Merged
Conversation
…ts and sections. The Features table crammed a full technical description of each feature into a cell, so the column ran to several lines and the reader had to parse an API signature to learn what the feature was for. It is now a list: an icon, the name, and the two links on the first line, then a plain sentence or two saying what it lets you do and why that helps. No method names, no argument shapes - those are on the reference page each entry links to. The Fields gallery was a two-column table of demo beside blurb, which squeezed every recording to half width and put the description where it read as a caption. Each field now has a heading that links to its reference, its description under it, and the recording at full width below that. The Themes section stated each palette twice - once in a table of names and once as a bold label over its screenshots. Each theme now has one section: the name as a heading, the palette description under it, and the dark and light renders below. The default theme joins them, noting that the demos at the top of the page are what it looks like. Two icons were both a compass; layouts takes a map instead.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe README was reformatted to replace feature, field, and theme tables with expanded Markdown sections. The update adds linked feature bullets, responsive light/dark field images, and dedicated descriptions for all six themes. ChangesREADME Documentation
Estimated code review effort: 1 (Trivial) | ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@README.md`:
- Around line 398-400: Update the README’s `default` theme section to include
previews for both its dark and light renders, matching the preview format used
by the other theme sections and preserving the existing description.
🪄 Autofix
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
This comment has been minimized.
This comment has been minimized.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #160 +/- ##
=======================================
Coverage 98.05% 98.05%
=======================================
Files 150 150
Lines 6054 6054
=======================================
Hits 5936 5936
Misses 118 118 ☔ View full report in Codecov by Harness. |
|
AlexSkrypnyk
added
the
Needs review
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.
Summary
The README's three gallery sections each presented their content in a shape that fought the content: Features packed API detail - method names, argument shapes, enum cases - into a dense table cell, Fields squeezed every demo recording to half width inside a raw HTML table, and Themes stated each palette twice. All three are now scannable lists and sections instead of tables: 23 feature bullets that describe what a feature lets you do rather than how to call it, 16 field sections with the recording at full width below its own heading and description, and 6 theme sections that state the palette once. Rendering was verified through GitHub's markdown API in
markdownmode (the mode a README actually renders in, unlikegfmcomment mode where soft newlines double up) - confirming 23 feature bullets, 22 field-and-theme sections, exactly one<br>per bullet, every local asset path resolving, and every phptui.dev link pointing at a page that exists. One tradeoff worth flagging: the page is now roughly 17 screens tall, about 4 more than before, because the 16 field recordings run about 440px each at full width instead of about 230px at half width.Changes
###heading linking to the field's reference page, the description underneath as its own paragraph, and the recording at full width below that; inline<code>and<strong>markup became plain markdown backticks and headings, while<kbd>stayed since GitHub renders it.###heading, the palette description underneath, and the dark and light renders below that;defaultjoins the list with a note saying why it carries no render of its own -render-theme-svgs.phpcovers only the four adaptive themes plusdos, and every recording on the README, both demos at the top and all sixteen fields, is already drawn indefault.Screenshots
Before / After
Summary by CodeRabbit