FuelLabs/fuels-rs

Add an Asset documentation section to the book

Open

#1309 opened on Mar 26, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (43,211 stars) (1,360 forks)batch import
dev-experiencedocumentationgood first issue

Description

We currently have documentation on how to send/receive/check balances of assets in multiple places throughout the book. There should be a section which covers assets from start to end.

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of Fuel networkFamiliarity with fuels rs documentation structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Review the linked documentation pages (Custom Asset Transfer, Output Variables, Call Parameters, Accounts, Checking Balances and Coins, AssetId) to understand the current scattered content. Then, create a new cohesive 'Assets' section in the book (likely in a new chapter or as a subsection) that consolidates and streamlines this information, ensuring it covers sending/receiving and checking balances of assets from start to end. Follow the existing book's style and structure, and consider adding cross references to other relevant sections.