Skip to content

Update README.md#2669

Closed
thomasbuilds wants to merge 2 commits into
solidjs:mainfrom
thomasbuilds:main
Closed

Update README.md#2669
thomasbuilds wants to merge 2 commits into
solidjs:mainfrom
thomasbuilds:main

Conversation

@thomasbuilds
Copy link
Copy Markdown
Contributor

@thomasbuilds thomasbuilds commented Apr 9, 2026

  • Replaced the root README.md with a symlink to packages/solid/README.md to eliminate duplication and centralize documentation.
  • Standardized README badges to match the style used across the broader Solid ecosystem.
  • Updated onboarding instructions to reflect the current recommended workflow using npm create solid.
  • Improved overall structure and wording for better readability and quicker comprehension.
  • Refined key sections, including core features, quick start, ecosystem links, and contribution/support (replacing hardcoded <a> links with dynamic Open Collective SVGs).
  • Added references to the wider Solid ecosystem (e.g., SolidStart, Solid Router, etc.).
  • Removed the unused and outdated banner.png.

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented Apr 9, 2026

⚠️ No Changeset found

Latest commit: 072b881

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@ryansolid
Copy link
Copy Markdown
Member

Thanks for putting this together. I’m going to close this one because it changes the README structure and project presentation much more broadly than we can review as a small docs update. In particular, replacing the root README with a pointer/symlink-style file and deleting the banner asset are not changes we want to make from this PR.

Some of the onboarding wording may be useful, but README structure and ecosystem positioning need to be handled separately and deliberately. Thank you again for the effort.

@ryansolid ryansolid closed this May 14, 2026
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.

2 participants