base-ui icon indicating copy to clipboard operation
base-ui copied to clipboard

[docs] Polish header of README and npm package

Open oliviertassinari opened this issue 7 months ago • 2 comments

This would hopefully improve the experience on https://www.npmjs.com/package/@base-ui-components/react and https://github.com/mui/base-ui/tree/master#baseui.

This is inspired by https://www.npmjs.com/package/tailwindcss or https://www.npmjs.com/package/next.

After: https://github.com/oliviertassinari/base-ui/blob/fix-readme-logo/packages/react/README.md

oliviertassinari avatar Apr 14 '25 22:04 oliviertassinari

Deploy Preview for base-ui ready!

Name Link
Latest commit 5f32715f1ec3e09f01bdb8d74c2a9ace25fba8e1
Latest deploy log https://app.netlify.com/sites/base-ui/deploys/67fd93482a962b00081a7cbd
Deploy Preview https://deploy-preview-1716--base-ui.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

netlify[bot] avatar Apr 14 '25 23:04 netlify[bot]

The logomark is much too large here, and the centered logo and centered h1 don't work with the left-aligned text below, at least not without a visible full-width background anchoring the centered logo.

If you want an image, some variation of our logo or social og image could potentially work.

colmtuite avatar Apr 15 '25 00:04 colmtuite

Looks like we're not proceeding further with this, so I propose to close it to limit the number of open PRs.

michaldudak avatar Jul 02 '25 11:07 michaldudak