Skip to content

🧹 Update documentation and fix typos#16

Open
rpsec wants to merge 1 commit into
mainfrom
update-documentation-and-typos-2778019697978167693
Open

🧹 Update documentation and fix typos#16
rpsec wants to merge 1 commit into
mainfrom
update-documentation-and-typos-2778019697978167693

Conversation

@rpsec
Copy link
Copy Markdown
Owner

@rpsec rpsec commented Mar 16, 2026

This PR ensures that the project's documentation accurately reflects its current platform support and future plans. It also fixes some spelling mistakes in error messages.

Changes made:

  • Updated AGENTS.md to document future FVM support and explicitly list supported platforms (Linux x64, macOS x64/Arm64, Windows x64).
  • Updated README.md to explicitly list supported platforms.
  • Updated docs/setup.md to explicitly list supported platforms.
  • Fixed spelling mistakes ("Plase" -> "Please", "manualy" -> "manually") in error messages in src/proto.rs.

Verified the changes locally using tests.


PR created automatically by Jules for task 2778019697978167693 started by @rpsec

🎯 What:
- Updated `AGENTS.md` to document future FVM support and explicitly list supported platforms (Linux x64, macOS x64/Arm64, Windows x64).
- Updated `README.md` to explicitly list supported platforms.
- Updated `docs/setup.md` to explicitly list supported platforms.
- Fixed spelling mistakes ("Plase" -> "Please", "manualy" -> "manually") in error messages in `src/proto.rs`.

💡 Why:
- Keeping documentation accurate and up-to-date helps users and future contributors understand the supported platforms and project goals. Fixing typos improves the quality of user-facing error messages.

✅ Verification:
- Verified diff.
- Compiled the WASM target (`cargo build --target wasm32-wasip1`).
- Ran tests (`cargo test --test metadata_test` and `cargo test --test versions_test`) successfully.

✨ Result:
- Documentation reflects the current state of supported platforms and future FVM plans. Typographical errors in CLI error outputs have been corrected.

Co-authored-by: rpsec <1322553+rpsec@users.noreply.github.com>
@google-labs-jules
Copy link
Copy Markdown

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

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