sway/docs/reference
Sven Eriksson 54e016971e
Some checks failed
CI / build-reference-examples (push) Has been cancelled
CI / forc-fmt-check-sway-lib-std (push) Has been cancelled
CI / forc-fmt-check-sway-examples (push) Has been cancelled
CI / get-fuel-core-version (push) Has been cancelled
CI / build-sway-lib-std (push) Has been cancelled
CI / cargo-clippy (push) Has been cancelled
CI / build-sway-examples (push) Has been cancelled
Codspeed Benchmarks / benchmarks (push) Has been cancelled
CI / check-dependency-version-formats (push) Has been cancelled
CI / check-forc-manifest-version (push) Has been cancelled
CI / forc-unit-tests (push) Has been cancelled
CI / forc-fmt-check-panic (push) Has been cancelled
CI / check-sdk-harness-test-suite-compatibility (push) Has been cancelled
CI / build-mdbook (push) Has been cancelled
CI / build-forc-doc-sway-lib-std (push) Has been cancelled
CI / build-forc-test-project (push) Has been cancelled
CI / cargo-build-workspace (push) Has been cancelled
CI / cargo-toml-fmt-check (push) Has been cancelled
CI / cargo-fmt-check (push) Has been cancelled
CI / cargo-test-lib-std (push) Has been cancelled
CI / forc-run-benchmarks (push) Has been cancelled
CI / forc-pkg-fuels-deps-check (push) Has been cancelled
CI / cargo-unused-deps-check (push) Has been cancelled
CI / pre-publish-check (push) Has been cancelled
github pages / deploy (push) Has been cancelled
CI / verifications-complete (push) Has been cancelled
CI / cargo-run-e2e-test (push) Has been cancelled
CI / cargo-run-e2e-test-release (push) Has been cancelled
CI / Build and test various forc tools (push) Has been cancelled
CI / notify-slack-on-failure (push) Has been cancelled
CI / publish (push) Has been cancelled
CI / publish-sway-lib-std (push) Has been cancelled
CI / Build and upload forc binaries to release (push) Has been cancelled
docs: fix a/an grammar errors in documentation (#7491)
**Description**:
  This PR fixes minor grammar errors found in the documentation:

  **Documentation fixes:**
  - Fixed "an the" → "the" in storage-vec documentation
- Fixed "an ContractId" → "a ContractId" (ContractId starts with
consonant sound)
  - Fixed "an Contract" → "a Contract"

<!-- CURSOR_SUMMARY -->
---

> [!NOTE]
> Fixes incorrect articles in docs ("an"→"a" and "an the"→"the") across
asset mint, ContractId, and StorageVec pages.
> 
> - **Documentation**:
>   - Correct article usage in:
> - `docs/reference/src/documentation/operations/asset/mint/contract.md`
("a Contract").
> -
`docs/reference/src/documentation/operations/namespace/contract-id.md`
("a ContractId").
> -
`docs/reference/src/documentation/operations/storage/libraries/storage-vec.md`
("the" instead of "an the").
> 
> <sup>Written by [Cursor
Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit
3106eec1d0. This will update automatically
on new commits. Configure
[here](https://cursor.com/dashboard?tab=bugbot).</sup>
<!-- /CURSOR_SUMMARY -->

Co-authored-by: Joshua Batty <joshpbatty@gmail.com>
2025-11-20 23:49:55 +00:00
..
src docs: fix a/an grammar errors in documentation (#7491) 2025-11-20 23:49:55 +00:00
theme Updated the sway.js file by adding mod and type in keyword (#4427) 2023-04-12 22:39:45 +00:00
.gitignore Introduce the Sway reference, a more technical Sway source of documentation. (#2562) 2022-12-08 21:53:09 +00:00
book.toml Introduce the Sway reference, a more technical Sway source of documentation. (#2562) 2022-12-08 21:53:09 +00:00
README.md Struct field privacy (#5508) 2024-01-30 17:15:24 +04:00

The Sway Reference

Setup

If you wish contribute to this reference:

  1. Install Rust if it's not installed.

  2. Install mdbook.

    cargo install mdbook
    
  3. To build the book, ensure you are in /docs/reference and run:

    mdbook build
    
  4. To serve a hot-reloading instance of the book in your browser, run:

    mdbook serve --open