cf7b6664b5
## Description Developers get confused by Sway's memory model as it is different from Rust's. So I added this to the docs. closes https://app.asana.com/0/1207924201336629/1208429018056446 ## Checklist - [x] I have linked to any relevant issues. - [ ] I have commented my code, particularly in hard-to-understand areas. - [x] I have updated the documentation where relevant (API docs, the reference, and the Sway book). - [ ] If my change requires substantial documentation changes, I have [requested support from the DevRel team](https://github.com/FuelLabs/devrel-requests/issues/new/choose) - [ ] I have added tests that prove my fix is effective or that my feature works. - [ ] I have added (or requested a maintainer to add) the necessary `Breaking*` or `New Feature` labels where relevant. - x ] I have done my best to ensure that my PR adheres to [the Fuel Labs Code Review Standards](https://github.com/FuelLabs/rfcs/blob/master/text/code-standards/external-contributors.md). - [x] I have requested a review from the relevant team or maintainers. --------- Co-authored-by: Sophie Dankel <47993817+sdankel@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| src | ||
| theme | ||
| .gitignore | ||
| .spellcheck.yml | ||
| book.toml | ||
| README.md | ||
| spell-check-custom-words.txt | ||
Documentation
Building From Source
Install mdbook and then open a new terminal session in order to run the subsequent commands
cargo install mdbook
To set up and build the book locally, you must also have mdbook-forc-documenter preprocessor and relevant forc plugins installed.
If you wish to make changes to the Commands or Plugins chapters, please read the next section first.
From the project root, install mdbook-forc-documenter:
cargo install --path ./scripts/mdbook-forc-documenter
You must also install forc plugins that are already documented within the book. You can skip plugins that are going to be removed and install plugins that are going to be added to the book:
cargo install --path ./forc-plugins/forc-client
cargo install --path ./forc-plugins/forc-doc
cargo install forc-explore
cargo install --path ./forc-plugins/forc-fmt
cargo install --path ./forc-plugins/forc-lsp
To build book:
mdbook build docs/book
To build the book on strict mode to check if pages should be removed or added within the Forc Reference:
MDBOOK_preprocessor__FORC_documenter__STRICT="true" mdbook build docs/book
To serve locally:
mdbook serve docs/book
Generating documentation for Forc commands/plugins
The mdbook-forc-documenter preprocessor now automatically handles documenting forc commands and plugins, but some actions have to be taken for the preprocessor to work. Please read the mdbook-forc-documenter README before making changes to Forc commands or plugins.
It is important to note that changing the chapter names Commands and Plugins will affect the behavior of the preprocessor. When renaming the chapters, please make the same change here.