Skip to content

docs: align README with stars-components layout#3

Merged
RedStar071 merged 1 commit into
mainfrom
docs/readme-stars-components-style
Jul 5, 2026
Merged

docs: align README with stars-components layout#3
RedStar071 merged 1 commit into
mainfrom
docs/readme-stars-components-style

Conversation

@RedStar071

@RedStar071 RedStar071 commented Jul 5, 2026

Copy link
Copy Markdown
Member

🔗 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-components keeps the ecosystem consistent for contributors and visitors.

📚 Description

Refactors the root README.md to match the stars-components template: 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

Before After
Text-only header with @wolfstar/plugins title Centered logo, "Plugins" title, license/codecov badges
Packages table with local links and descriptions Packages table with npmx version/download badges
Development, Tooling, Releasing, and License sections Open in your editor and Contributing sections

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Documentation change
  • Workflow / CI change

Pre-flight Checklist

  • I have read the Contributing Guidelines (if applicable)
  • My code follows the code style of this project
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • I have updated the documentation accordingly
  • I added a changeset with pnpm changeset (or pnpm changeset add --empty if no release is needed). See .changeset/README.md.

View with Codesmith
Need help on this PR? Tag /codesmith with 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

T-Rex T-Rex Logs

What T-Rex did

  • Compared the before and after README header rendering to confirm the header now displays a centered WolfStar logo with a Plugins title and badges.
  • Reviewed the head README changes to verify Open in your editor shortcuts and the contrib.rocks image appear, along with the updated header sections.
  • Verified that the head README passes all template checks, with no missing sections or fallback requirements.

View all artifacts

T-Rex Ran code and verified through T-Rex

Fix All in Claude Code Fix All in Cursor Fix All in Cursor Cloud Agents

Prompt To Fix All With AI
Fix the following 2 code review issues. Work through them one at a time, proposing concise fixes.

---

### Issue 1 of 2
README.md:20
**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.

### Issue 2 of 2
README.md:38
**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.

Reviews (1): Last reviewed commit: "docs: align README with stars-components..." | Re-trigger Greptile

Greptile also left 2 inline comments on this PR.

Co-authored-by: Cursor <cursoragent@cursor.com>
@codecov

codecov Bot commented Jul 5, 2026

Copy link
Copy Markdown

✅ All tests passed.

@RedStar071
RedStar071 merged commit d7d786d into main Jul 5, 2026
12 of 14 checks passed
@RedStar071
RedStar071 deleted the docs/readme-stars-components-style branch July 5, 2026 10:30
Comment thread README.md
## Development
| Package | Version | Downloads |
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
| [`@wolfstar/plugin-api`](https://npmx.dev/package/@wolfstar/plugin-api) | [![version](https://npmx.dev/api/registry/badge/version/@wolfstar/plugin-api)](https://npmx.dev/package/@wolfstar/plugin-api) | [![downloads](https://npmx.dev/api/registry/badge/downloads/@wolfstar/plugin-api)](https://npmx.dev/package/@wolfstar/plugin-api) |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

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.

Fix in Claude Code Fix in Cursor Fix in Cursor Cloud Agents

Comment thread README.md
pnpm changeset
```
Please read the [Contributing Guide][contributing] before submitting a pull request.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 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.

Fix in Claude Code Fix in Cursor Fix in Cursor Cloud Agents

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