Skip to content

Add RAPx tool documentation - #631

Open
DiuDiu777 wants to merge 1 commit into
model-checking:mainfrom
safer-rust:rapx-tool-docs
Open

Add RAPx tool documentation#631
DiuDiu777 wants to merge 1 commit into
model-checking:mainfrom
safer-rust:rapx-tool-docs

Conversation

@DiuDiu777

Copy link
Copy Markdown

This is a follow-up to #491.

It adds the RAPx tool documentation to the verify-rust-std book.

@DiuDiu777
DiuDiu777 requested a review from a team as a code owner August 11, 2026 04:11
@feliperodri
feliperodri requested a lite review from Copilot August 12, 2026 02:17
@feliperodri feliperodri added the Tool Application Used to tag tool application label Aug 12, 2026

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

This PR adds RAPx documentation to the verify-rust-std mdBook and links it from the Tools chapter/navigation, as a follow-up to PR #491.

Changes:

  • Adds a new RAPx tool page (doc/src/tools/rapx.md) describing installation and usage.
  • Adds RAPx to the “Approved tools” table (doc/src/tools.md) with a CI badge link.
  • Adds RAPx to the book sidebar (doc/src/SUMMARY.md).

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
doc/src/tools/rapx.md New RAPx tool documentation page (installation/usage + std-lib verification notes).
doc/src/tools.md Adds RAPx to the approved-tools table and links to a rapx.yml workflow badge.
doc/src/SUMMARY.md Adds RAPx to the Tools navigation list.
Suppressed comments (2)

doc/src/tools/rapx.md:30

  • This section refers to .github/workflows/rapx.yml for pinned toolchain/RAPx versions, but there is no rapx.yml workflow file in the repository. This makes the instructions non-actionable and the reference a dead link.
The RAPx workflow in this repository pins both the Rust nightly toolchain and
the RAPx revision used by CI. See `.github/workflows/rapx.yml` for the exact
versions.

doc/src/tools/rapx.md:107

  • This claims there is a "current CI job" verifying slice for challenge 17, but there is no RAPx workflow in the repository. Reword to describe how to run it locally (and how a CI job would be configured) without asserting it already exists.
The current CI job verifies the slice module for challenge 17. From the root of
a local `verify-rust-std` checkout, set up the environment in the same way as
the workflow:


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

Comment thread doc/src/tools.md
Comment thread doc/src/tools/rapx.md

@feliperodri feliperodri left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

You can ignore Copilot comments, but let's wait #491 gets merge first before merging this one. cc. @tautschnig

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Tool Application Used to tag tool application

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants