FuelLabs/sway

[forc-doc] Add a link to the docs hub in the standard library

Open

#4,194 建立於 2023年2月27日

在 GitHub 查看
 (7 留言) (0 反應) (0 負責人)Rust (61,702 star) (5,421 fork)batch import
ODHack13forc-docgood first issuelib: stdmay be rewarded

描述

When clicking into an item in the sdt library docs, I would expect to see a navigation sidebar with all of the links in the docs website, similar to https://doc.rust-lang.org/

貢獻者指南

技術棧
rust
領域
documentationtooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
stale
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Rust programming languagefamiliarity with documentation generation toolsunderstanding of Sway standard library
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
45
研究方向
Examine the forc doc source code in the sway repository, likely in the forc plugins/forc doc directory. Understand how the documentation HTML is generated and where navigation components are defined. Review the existing documentation layout and the Rust docs sidebar for reference. Check the issue comments for any additional guidance.