Repository navigation
Redesign the README - #13
Merged
Merged
Conversation
Centered header with badges and the demo, a feature grid, a mermaid diagram, install per platform, a quick start and a comparison table up front. The reference sections keep all their content, with the longest parts in collapsible blocks, plus an FAQ, contributing notes and a star history chart.
Replace the icon and for-the-badge header with a light and dark banner, a link row and two flat badges. Put the overview video and the install steps in the first screen, show the main features with screenshots, and turn wide tables into lists so the page reads on a phone. Drop the star history chart. Every section anchor stays the same.
Kernel-Hunter
force-pushed
the
readme-redesign
branch
from
October 30, 2026 19:53
8952215 to
591d89e
Compare
The sign-in and default-host tables and the left-to-right diagram were too wide to read on a phone.
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.
Reworks the README header and top section to look more like the READMEs of large app repos, and to read well on a phone.
<picture>(docs/assets/mudroom-banner-*.png), replacing the icon and the for-the-badge shields<details>docs/screenshots(review, network, conflict, timeline), themed where a dark version exists<details>. Other agent sandboxes, requirements, sign-in methods and default hosts are lists now, since the tables scrolled sideways on a phoneThe reference sections are unchanged apart from that, and every anchor the site and the docs link to still works (
#install,#limitations,#install-on-windows,#windows-1,#contents,#keep-files-out-of-the-sandboxand the rest). Rebased on main, so the Windows zip example says 0.5.0.