docs: align README with stars-components layout#3
Conversation
Co-authored-by: Cursor <cursoragent@cursor.com>
|
✅ All tests passed. |
| ## Development | ||
| | Package | Version | Downloads | | ||
| | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | | ||
| | [`@wolfstar/plugin-api`](https://npmx.dev/package/@wolfstar/plugin-api) | [](https://npmx.dev/package/@wolfstar/plugin-api) | [](https://npmx.dev/package/@wolfstar/plugin-api) | |
There was a problem hiding this comment.
The package table now relies on the external npmx/npm page for @wolfstar/plugin-api instead of the local package path. If that package has not been published yet, the README's only package row shows broken or empty version/download badges and sends readers away from the source package that exists in this repo.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 20
Comment:
**Package Badges Point Nowhere**
The package table now relies on the external npmx/npm page for `@wolfstar/plugin-api` instead of the local package path. If that package has not been published yet, the README's only package row shows broken or empty version/download badges and sends readers away from the source package that exists in this repo.
How can I resolve this? If you propose a fix, please make it concise.| pnpm changeset | ||
| ``` | ||
| Please read the [Contributing Guide][contributing] before submitting a pull request. | ||
|
|
There was a problem hiding this comment.
Contributing Path Leaves Repository
This README now makes .github/CONTRIBUTING.md the contributor entry point after removing the local setup and release sections. That guide's pull-request link targets the stars-components repository, so contributors following the new README path can end up opening or looking for PRs in the wrong project.
Prompt To Fix With AI
This is a comment left during a code review.
Path: README.md
Line: 38
Comment:
**Contributing Path Leaves Repository**
This README now makes `.github/CONTRIBUTING.md` the contributor entry point after removing the local setup and release sections. That guide's pull-request link targets the `stars-components` repository, so contributors following the new README path can end up opening or looking for PRs in the wrong project.
How can I resolve this? If you propose a fix, please make it concise.
🔗 Linked issue
N/A
🧭 Context
The root README used a development-focused layout that differed from the presentation used across other Wolfstar monorepos. Aligning it with
wolfstar-project/stars-componentskeeps the ecosystem consistent for contributors and visitors.📚 Description
Refactors the root
README.mdto match thestars-componentstemplate: centered header with WolfStar logo, license and codecov badges, an npmx-powered packages table, cloud IDE shortcuts, and a contributing section with contrib.rocks.Development, tooling, and releasing sections were removed from the README; that information remains available in
package.json,.github/CONTRIBUTING.md, and CI workflows.Key changes
@wolfstar/pluginstitleType of Change
Pre-flight Checklist
pnpm changeset(orpnpm changeset add --emptyif no release is needed). See .changeset/README.md.Need help on this PR? Tag
/codesmithwith what you need. Autofix is enabled.Confidence Score: 5/5
The README-only change looks mergeable after fixing the broken documentation paths.
The changed package table can send readers to an external package page before the package is available there, and the new contributor entry point can route contributors to the wrong repository through the linked guide. No runtime, build, or security behavior changed.
README.md
What T-Rex did
Prompt To Fix All With AI
Reviews (1): Last reviewed commit: "docs: align README with stars-components..." | Re-trigger Greptile