Skip to content

Repair Carapace README version and ARIA link#16

Merged
ryan10sa-star merged 1 commit into
mainfrom
codex/repair-carapace-readme-v05
Jun 12, 2026
Merged

Repair Carapace README version and ARIA link#16
ryan10sa-star merged 1 commit into
mainfrom
codex/repair-carapace-readme-v05

Conversation

@ryan10sa-star

@ryan10sa-star ryan10sa-star commented Jun 12, 2026

Copy link
Copy Markdown
Collaborator

Summary

  • update top-level Carapace README version badge and package version text to v0.5.0
  • mark v0.4.0 as shipped and add v0.5.0 as current in the roadmap
  • replace the broken ARIA Registry link with the live API docs URL

Verification


View with Codesmith Autofix with Codesmith
Need help on this PR? Tag /codesmith with what you need. Autofix is disabled.

@ryan10sa-star ryan10sa-star marked this pull request as ready for review June 12, 2026 14:06
Copilot AI review requested due to automatic review settings June 12, 2026 14:06
@ryan10sa-star ryan10sa-star merged commit e5747de into main Jun 12, 2026
2 checks passed
@ryan10sa-star ryan10sa-star deleted the codex/repair-carapace-readme-v05 branch June 12, 2026 14:06

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

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.0 as shipped and v0.5.0 as current.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread README.md
Comment on lines +80 to 81
Canonical package names for `v0.5.0` are `carapace-sdk` on npm and
`carapace-sdk` on PyPI. Python imports use the `carapace` module.

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 Badge 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 👍 / 👎.

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