docs: unify README with the shared skeleton and expand the org profile - #4
Conversation
Give the repo README the same skeleton as the code repos. The org profile is the front door at github.com/muxlang rather than a repo README, so it keeps the shared visual identity but gets a landing-page treatment: a first-taste code sample, install and playground calls to action, why-Mux highlights, and the repo map.
|
| Filename | Overview |
|---|---|
| README.md | Adds centered logo + badge header, converts bullet-list inventory to a table, adds "How syncing works" section and a Related repositories table with a license footer — purely additive documentation improvements, no logic changes. |
| profile/README.md | Expands org landing page with centered hero, four distinct badge links (Website, Docs, Playground, License), a first-taste code sample, install snippet, "Why Mux?" highlights, and a tightened "Getting involved" section — editorial content only, no code logic. |
Reviews (2): Last reviewed commit: "docs: point the playground badge at the ..." | Re-trigger Greptile
The Website and Playground badges both linked to the site root. The playground has its own route, so link it there.
|
Triage of the two findings: 1. Duplicate badge destination — valid, fixed. The Website and Playground badges both pointed at the site root. There is a distinct playground route ( 2. Sonar badge — not applying. Flagged as possibly unregistered. Verified against the live endpoint instead of assuming: |
|



Part of muxlang/mux-context#14.
Two different jobs here, so two different treatments:
README.md(this repo's own) gets the shared skeleton like the code repos: centered logo + title + tagline, badge row,---dividers, Related repositories table, License/maintainer footer.profile/README.mdis the org front door at github.com/muxlang, not a repo README. It keeps the shared visual identity but gets a landing-page treatment: a first-taste code sample, install + playground calls to action, why-Mux highlights, and the repo map.Making the profile byte-identical to a library README would undersell the one page that should be the most expressive, so "unify" here means shared chrome across the library repos plus a more editorial profile.
The code sample is lifted from the mux-compiler README so it is known-valid Mux.
🤖 Generated with Claude Code