Skip to content

Commit

Permalink
docs: link to docs hub fuel installation guide (#1153)
Browse files Browse the repository at this point in the history
## Description

In order to remove documentation redundancy issues, the fuel
installation guide is being centralized in the docs-hub.
Check [docs-hub/62](FuelLabs/docs-hub#62)


## Checklist

- [x] I have linked to any relevant issues.
- [x] 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).
- [ ] 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).
- [ ] I have requested a review from the relevant team or maintainers.

---------

Co-authored-by: Oleksii Filonenko <[email protected]>
Co-authored-by: Ahmed Sagdati <[email protected]>
  • Loading branch information
3 people committed Oct 15, 2023
1 parent 27f43c0 commit e22f279
Showing 1 changed file with 3 additions and 12 deletions.
15 changes: 3 additions & 12 deletions docs/src/getting-started.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,15 @@
# Getting Started

## Dependencies
## Installation Guide

<!-- This section should list the dependencies for the Fuel Rust SDK -->
<!-- rs_dependencies:example:start -->
The dependencies for using the Fuel Rust SDK are:

-- [The latest `stable` Rust toolchain](https://docs.fuel.network/guides/installation/#installing-rust);
-- [`forc` and `fuel-core` binaries](https://docs.fuel.network/guides/installation/#installing-the-fuel-toolchain-using-fuelup).
<!-- rs_dependencies:example:end -->
Please visit the Fuel [installation guide](https://docs.fuel.network/guides/installation) to install the Fuel toolchain binaries and prerequisites.

`forc` is Sway equivalent of Rust's `cargo`. `fuel-core` is a Fuel full node implementation.

<!-- This section should list the main ways developers can use the Fuel Rust SDK -->
<!-- rs_uses:example:start -->
There are two main ways you can use the Fuel Rust SDK:

1. Creating a new Sway project with `forc` and running the tests
2. Creating a standalone project and importing the `fuels-rs` crate
<!-- rs_uses:example:end -->

## Creating a new project with Forc

Expand Down Expand Up @@ -135,4 +126,4 @@ cargo test -- --nocapture

## More in-depth Fuel and Sway knowledge

Read [The Sway Book](https://fuellabs.github.io/sway/master/book/introduction/index.html) for more in-depth knowledge about Sway, the official smart contract language for the Fuel Virtual Machine.
Read [The Sway Book](https://docs.fuel.network/docs/sway/) for more in-depth knowledge about Sway, the official smart contract language for the Fuel Virtual Machine.

0 comments on commit e22f279

Please sign in to comment.