FuelLabs/sway

Update the Sway Book to document the abbreviations for any `forc` commands.

Open

#1,890 opened on Jun 7, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Rust (61,702 stars) (5,421 forks)batch import
The Sway Bookgood first issue

Description

Context

The Sway Book has a commands section for forc. When taking a look at forc build and forc test they do not document the shorthand e.g.

  1. forc build can be used as forc b
  2. forc test can be used as forc t

There may be other shorthand commands that have been added but are undocumented.

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
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
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
First, identify all forc commands that have shorthand abbreviations by running `forc help` or reviewing the command definitions in the source code (e.g., in `forc/src/cli/`). Then, locate the documentation files for the Sway Book, likely under `docs/book/src/commands/`. For each command, add the abbreviation (e.g., `forc b` for `forc build`) to the corresponding documentation page. Ensure consistency with existing format.