Add Rust in the SDK section #1471
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
Adds support for the Rust SDK in our documentation and sync script.
- Updates
sync-docs.shto include Rust in SDK sync, source directory mapping, and version replacement - Introduces a Quickstart guide and RST wrapper for the Rust SDK
- Adds a placeholder
API.mdfor Rust and updates the drivers overview to list Rust SDK
Reviewed Changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| sync-docs.sh | Added “rs” to SDKS list, mapped source_dir to “rust”, and added RUSTVERSION replace call |
| source/developers/rust/quickstart.md | Created Rust SDK quickstart guide |
| source/developers/rust/minio-rust.rst | Added RST page including the quickstart and toctree entry |
| source/developers/rust/API.md | Placeholder file returning “404: Not Found” |
| source/developers/minio-drivers.rst | Added Rust SDK to the drivers list and toctree |
Comments suppressed due to low confidence (2)
sync-docs.sh:44
- The script attempts to fetch API.md for Rust even though it doesn't exist yet, resulting in a 404 placeholder. Consider conditionally skipping the API.md download for the rust SDK or handling missing API docs gracefully.
curl --retry 10 -Ls -o source/developers/${source_dir}/API.md https://raw.githubusercontent.com/minio/minio-${sdk}/${sdk_version}/${sdk_dir}/API.md
sync-docs.sh:41
- [nitpick] Indentation for the Rust case branch is inconsistent with the other SDK cases. Align the tabs/spaces to match existing formatting for readability.
source_dir="rust" # no API.md yet
ravindk89
approved these changes
Jun 4, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New SDK page for the Rust SDK, with a quickstart from
minio/minio-rs/README.mdGoing with an external link to a generated reference. Will deal with API.md as we can.
We may yet get anAPI.md, so this PR is a draft for now.