FuelLabs/fuels-rs

Add docs for the fuel_types crate

Open

#1,300 创建于 2024年3月19日

在 GitHub 查看
 (1 评论) (0 反应) (0 负责人)Rust (43,211 star) (1,360 fork)batch import
documentationgood first issue

描述

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

贡献者指南

技术栈
rust
领域
documentationdeveloper experience
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
fresh
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
basic Rustknowledge of fuel types crate
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
80
研究方向
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.