Skip to content

docs: reconcile docs with the shipped v1.1.0 release#14

Merged
kexi merged 1 commit into
mainfrom
docs/readme-post-release-cleanup
Jun 7, 2026
Merged

docs: reconcile docs with the shipped v1.1.0 release#14
kexi merged 1 commit into
mainfrom
docs/readme-post-release-cleanup

Conversation

@kexi

@kexi kexi commented Jun 7, 2026

Copy link
Copy Markdown
Owner

Summary

Bring the docs in line with what actually shipped (v1.1.0 released; macOS Intel dropped; Marketplace listing is pitty-action):

  • README: drop the now-obsolete @main bootstrap caveat (the first release has happened) and replace it with a Marketplace note linking the pitty-action listing; clarify the listing name doesn't change uses: kexi/pitty@v1.
  • COMPATIBILITY: prebuilt count four → three, "eight assets" → "six (three per ref)", "all three jobs" → "all four", note the bootstrap window is closed, document the pitty-action name + unique-name requirement.
  • CHANGELOG: 1.1.0 shipped three targets, not four (macOS Intel → cargo fallback).

Test plan

  • cargo test + fmt clean (docs-only, no code change)
  • README/COMPATIBILITY internal links resolve; no stale four/eight counts remain

Now that v1.1.0 is released and Intel was dropped, fix stale docs:
- README: replace the obsolete `@main` bootstrap caveat (the first release has
  happened) with a Marketplace note pointing at the `pitty-action` listing.
- COMPATIBILITY: prebuilt count four → three, "eight assets" → "six", "all three
  jobs" → "all four", record that the bootstrap window is closed, and document
  the `pitty-action` listing name + the unique-name requirement.
- CHANGELOG: 1.1.0 shipped three targets, not four (macOS Intel uses the cargo
  fallback).

Co-Authored-By: Claude <noreply@anthropic.com>
@kexi kexi merged commit 38b0d4d into main Jun 7, 2026
10 checks passed
@kexi kexi deleted the docs/readme-post-release-cleanup branch June 7, 2026 08:20
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