Skip to content

Conversation

zees-dev
Copy link
Contributor

@zees-dev zees-dev commented Apr 30, 2025

Description

This pull request introduces updates to the documentation and examples for the forc call command, improving clarity, organization, and usability.
The most significant changes include restructuring the documentation into a new file, updating the book summary to reflect this change, and enhancing the examples in the codebase for better readability.

Added dedicated section for forc-call under testing heading.

image

Documentation Updates:

  • New Documentation File for forc call: The detailed documentation for the forc call command has been moved to a new file, docs/book/src/forc/plugins/forc_client/forc_call_docs.md. This includes comprehensive usage examples, parameter encoding details, and troubleshooting tips.
  • Removal of Old Documentation: The old forc_call.md file has been removed, as its content has been migrated to the new structured format.

Book Summary Update:

  • Updated SUMMARY.md: The book summary has been updated to include a link to the new forc call documentation under the "Testing" section for better navigation.

Code Example Enhancements:

  • Improved Examples in call.rs: Examples in the forc call command's code file (forc-plugins/forc-client/src/cmd/call.rs) have been reformatted for clarity. Each example now uses markdown-style code blocks and descriptive headings, making them easier to follow.

Checklist

  • I have linked to any relevant issues.
  • I have commented my code, particularly in hard-to-understand areas.
  • I have updated the documentation where relevant (API docs, the reference, and the Sway book).
  • I have added tests that prove my fix is effective or that my feature works.
  • I have added (or requested a maintainer to add) the necessary Breaking* or New Feature labels where relevant.
  • I have done my best to ensure that my PR adheres to the Fuel Labs Code Review Standards.
  • I have requested a review from the relevant team or maintainers.

@zees-dev zees-dev added good first issue Good for newcomers The Sway Book Everything to do with the Sway Book documentation forc-call Everything related to the `forc-call` plugin in `forc-client` package labels Apr 30, 2025
@zees-dev zees-dev self-assigned this Apr 30, 2025
@zees-dev zees-dev requested review from a team as code owners April 30, 2025 06:05
sdankel
sdankel previously approved these changes Apr 30, 2025
kayagokalp
kayagokalp previously approved these changes Apr 30, 2025
Copy link
Member

@kayagokalp kayagokalp left a comment

Choose a reason for hiding this comment

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

The current change looks good to me but we want to fix #7138 sooner or later so that the invalid title and random formatting stuff (forc-call docs being italic) does not happen.

@zees-dev zees-dev dismissed stale reviews from kayagokalp and sdankel via 06b3b7a May 1, 2025 13:27
@zees-dev zees-dev temporarily deployed to fuel-sway-bot May 1, 2025 13:27 — with GitHub Actions Inactive
@zees-dev zees-dev temporarily deployed to fuel-sway-bot May 1, 2025 13:35 — with GitHub Actions Inactive
@zees-dev zees-dev temporarily deployed to fuel-sway-bot May 1, 2025 13:37 — with GitHub Actions Inactive
@zees-dev zees-dev merged commit 66c9c1f into master May 2, 2025
43 checks passed
@zees-dev zees-dev deleted the fix/forc-call-examples branch May 2, 2025 04:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation forc-call Everything related to the `forc-call` plugin in `forc-client` package good first issue Good for newcomers The Sway Book Everything to do with the Sway Book
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants