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.