Skip to content

Remove obsolete README documentation references - #138

Merged
mxsm merged 1 commit into
mainfrom
mxsm/remove-obsolete-readme-links
Jul 26, 2026
Merged

Remove obsolete README documentation references#138
mxsm merged 1 commit into
mainfrom
mxsm/remove-obsolete-readme-links

Conversation

@mxsm

@mxsm mxsm commented Jul 26, 2026

Copy link
Copy Markdown
Owner

Summary

  • Remove the historical diagnostics paragraph from Safety and portability because its local bench-results and docs targets were deleted during the v3.0.0 cleanup.
  • Remove the now-empty Migration and architecture section, including seven dead migration/ADR links and the stale v3-alpha compatibility note.
  • Preserve the valid CI, unsafe-constructor, and UTF-8 safety guidance.

Why

The referenced documentation no longer exists in the repository, leaving the README with misleading descriptions and broken local links.

Impact

Documentation only. No Rust code, API, build configuration, or runtime behavior changes.

Check

  • git diff --check
  • Confirmed the diff is limited to README.md and 23 obsolete lines.

Closes #137

@coderabbitai

coderabbitai Bot commented Jul 26, 2026

Copy link
Copy Markdown

Warning

Review limit reached

@mxsm, you've reached your PR review limit, so we couldn't start this review.

Next review available in: 11 minutes

Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available.
You're only billed for reviews past your plan's rate limits ($0.25/file).

How can I continue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews.

How do review limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please refer docs for additional details.

Review details
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro Plus

Run ID: d130c44f-d4bc-4a70-b831-998d3c80a0f3

📥 Commits

Reviewing files that changed from the base of the PR and between 84c8d84 and c96c03f.

📒 Files selected for processing (1)
  • README.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch mxsm/remove-obsolete-readme-links

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@mxsm
mxsm marked this pull request as ready for review July 26, 2026 11:14
Copilot AI review requested due to automatic review settings July 26, 2026 11:14

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

Removes outdated sections from the README that referenced documentation paths deleted during the v3.0.0 cleanup, aiming to eliminate misleading text and dead local links while keeping current safety guidance intact.

Changes:

  • Removed the historical diagnostics paragraph from “Safety and portability” that linked to removed local artifacts.
  • Removed the now-empty “Migration and architecture” section, including stale migration/ADR links and v3-alpha compatibility wording.

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

Comment thread README.md
Comment on lines 185 to 187
The unsafe constructors are explicitly named and require the caller to prove
UTF-8 validity. Safe byte constructors validate before creating text.

@mxsm
mxsm merged commit e61ce79 into main Jul 26, 2026
8 checks passed
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.

Remove obsolete README documentation references

2 participants