FuelLabs/sway

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

Open

#4.194 geöffnet am 27. Feb. 2023

Auf GitHub ansehen
 (7 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (5.421 Forks)batch import
ODHack13forc-docgood first issuelib: stdmay be rewarded

Repository-Metriken

Stars
 (61.702 Stars)
PR-Merge-Metriken
 (Durchschn. Merge 5T 4h) (19 gemergte PRs in 30 T)

Beschreibung

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/

Contributor Guide

Research-Richtung
Untersuche den forc doc Quellcode im sway Repository, wahrscheinlich im Verzeichnis forc plugins/forc doc. Verstehe, wie die Dokumentations HTML generiert wird und wo Navigationskomponenten definiert sind. Überprüfe das bestehende Dokumentationslayout und die Rust Dokumentations Seitenleiste als Referenz. Prüfe die Issue Kommentare auf zusätzliche Anleitungen.
Tech Stack
rust
Domain
documentationtooling
Issue Type
Funktion
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
3
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Halber Tag
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Veraltet
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Rust programming languagefamiliarity with documentation generation toolsunderstanding of Sway standard library
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
45