FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1300 opened on Mar 19, 2024

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (43,211 stars) (1,360 forks)batch import
documentationgood first issue

Description

This comes from a developer experience feedback made by a grantee user.

go to github fuel-rs and search for bytes64 you'll get one result then go and search in the docs - no results they're imported from use fuel_types::bytes64 and the proper crate should be imported

Contributor guide

Tech stack
rust
Domain
documentationdeveloper experience
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
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 Rustknowledge of fuel types crate
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
The issue requests adding documentation for the fuel types crate, specifically for types like bytes64. Start by examining the fuel types crate in the fuels rs repository to understand the existing types and their usage. Focus on adding doc comments to public types and functions, and consider creating a short guide or module level documentation. Look at the issue comments for any additional context or specific user feedback. Ensure the docs are consistent with the style used elsewhere in the SDK.