FuelLabs/sway

Add appendix to the Sway book: Operators & Symbols

Open

#4,931 opened on Aug 9, 2023

View on GitHub
 (6 comments) (0 reactions) (0 assignees)Rust (5,421 forks)batch import
ODHack12ODHack13The Sway Bookgood first issuemay be rewarded

Repository metrics

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

Description

The Rust book has an appendix that details language operators and symbols in a table with an example of each operator's syntax and a description of its use. I think new users of the Sway language could benefit from the same type of index.

Contributor guide

Research direction
Start by reviewing the existing Sway book structure in the repository. Then, compile a list of all operators and symbols used in the Sway language, referencing the Sway compiler source if needed. Model the table after the Rust book's appendix, including syntax examples and brief descriptions. Create a new markdown file and add a link in the book's table of contents. Specifically, look at the current book's summary.md or toc.yml to add the new appendix.
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.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Basic knowledge of SwayRust book appendix reference
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80