Repair Carapace README version and ARIA link#16
Conversation
There was a problem hiding this comment.
Pull request overview
Updates the top-level repository README to reflect the latest Carapace release and to fix a broken ARIA Registry link, keeping public-facing documentation consistent with the current shipped version.
Changes:
- Updated the ARIA Registry link to the live API docs URL.
- Bumped the README version badge and referenced “canonical package names” text to
v0.5.0. - Updated the roadmap to mark
v0.4.0as shipped andv0.5.0as current.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 9f2635589e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| Canonical package names for `v0.5.0` are `carapace-sdk` on npm and | ||
| `carapace-sdk` on PyPI. Python imports use the `carapace` module. |
There was a problem hiding this comment.
Do not advertise v0.5.0 before PyPI is published
This line now tells users that the installable PyPI package corresponds to v0.5.0, but the public PyPI project page for carapace-sdk still reports latest version 0.4.0 with only 0.4.0/0.2.0/0.1.x releases. In the current state, users following pip install carapace-sdk will not get the README's v0.5.0 APIs, so the README should either wait for the package publish or call out that v0.5.0 is source/GitHub-only until PyPI is updated.
Useful? React with 👍 / 👎.
Summary
Verification
Need help on this PR? Tag
/codesmithwith what you need. Autofix is disabled.