FuelLabs/sway

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

Open

Aperta il 27 feb 2023

Vedi su GitHub
 (7 commenti) (0 reazioni) (0 assegnatari)Rust (61.702 star) (5421 fork)batch import
ODHack13forc-docgood first issuelib: stdmay be rewarded

Descrizione

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/

Guida contributor

Tech stack
rust
Dominio
documentationtooling
Tipo issue
feature
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
half day
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
Rust programming languagefamiliarity with documentation generation toolsunderstanding of Sway standard library
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45
Direzione di ricerca
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.