FuelLabs / FuelLabs/sway

docs: extract forc chapters into its own Forc reference

Open
#3,554 1 comment 0 reactions 0 assignees View on GitHub
documentation forc The Sway Book
Dominant language
Rust
Stars
61.4k
Forks
5.4k
Avg merge
3h 33m
Merged PRs (30d)
4

Description

Currently the Forc chapters within the Sway book is a bit out of place - it's not really teaching the Sway language but teaching the reader how to use Forc, manage the Forc.toml, etc. This is like the [Rust book](https://doc.rust-lang.org/stable/book/) <> [Cargo book](https://doc.rust-lang.org/cargo/).

I think it'd be nicer/neater to have a separate Forc reference. We can extract the Forc chapters out of the Sway book and start with that, but as we add more documentation to that we can take inspiration from the writing style of Cargo book and the [Sway reference](https://fuellabs.github.io/sway/master/reference/).

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by locating the Forc chapters within the Sway book and reviewing how the existing Sway reference is organized. Extract the Forc-focused material into a separate Forc reference, with the resulting documentation structure and links working as the completion criteria.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.