FuelLabs/sway

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

Open

#4,194 opened on Feb 27, 2023

View on GitHub
 (7 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
ODHack13forc-docgood first issuelib: stdmay be rewarded

Repository metrics

Stars
 (61,702 stars)
PR merge metrics
 (Avg merge 5d 4h) (19 merged PRs in 30d)

Description

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 direction
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.
Tech stack
rust
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Rust programming languagefamiliarity with documentation generation toolsunderstanding of Sway standard library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45