Skip to content

docs: unify README with the shared skeleton and expand the org profile - #4

Merged
DerekCorniello merged 2 commits into
mainfrom
docs/unify-readme
Jul 16, 2026
Merged

docs: unify README with the shared skeleton and expand the org profile#4
DerekCorniello merged 2 commits into
mainfrom
docs/unify-readme

Conversation

@DerekCorniello

Copy link
Copy Markdown
Contributor

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.md is 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

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.
@greptile-apps

greptile-apps Bot commented Jul 16, 2026

Copy link
Copy Markdown

Greptile Summary

This PR gives both READMEs a shared visual identity (centered logo, badge row, --- dividers, Related repositories table) while keeping the org profile (profile/README.md) intentionally more editorial than a standard library README.

  • README.md gains a structured inventory table, a "How syncing works" section, a Related repositories table, and a license/maintainer footer — all content that was either missing or buried in prose.
  • profile/README.md is promoted to a proper landing page with a code sample (lifted from mux-compiler README), install + playground calls to action, and a "Why Mux?" highlights list, while the Playground badge now correctly targets /playground (distinct from the Website badge).
  • The HTML <div align="center"> blocks are properly opened and closed in both files, and all badge destination URLs are unique and point to meaningful targets.

Confidence Score: 5/5

Documentation-only changes with no code logic; both files are structurally sound and ready to merge.

Both files are pure Markdown with no executable logic. HTML tags are balanced, badge URLs are distinct and point to meaningful targets, and the code sample in the profile is stated to be lifted from the already-reviewed mux-compiler README. Nothing here can break a build or introduce a runtime regression.

No files require special attention.

Important Files Changed

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

Comment thread profile/README.md Outdated
Comment thread README.md
The Website and Playground badges both linked to the site root. The playground
has its own route, so link it there.
@DerekCorniello

Copy link
Copy Markdown
Contributor Author

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 (src/pages/playground.tsx, and https://mux-lang.dev/playground returns 200), so the Playground badge and the inline "try it" link now point there.

2. Sonar badge — not applying. Flagged as possibly unregistered. Verified against the live endpoint instead of assuming: sonar-project.properties sets sonar.projectKey=muxlang_.github, this repo runs .github/workflows/sonar.yml, and the badge endpoint returns HTTP 200 rendering "quality gate passed". The badge resolves.

@sonarqubecloud

Copy link
Copy Markdown

@DerekCorniello
DerekCorniello merged commit 311fa30 into main Jul 16, 2026
3 checks passed
@DerekCorniello
DerekCorniello deleted the docs/unify-readme branch July 16, 2026 02:41
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