Skip to content

Commit

Permalink
docs: link to docs hub fuel installation guide (#5144)
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.
  • Loading branch information
cold-briu authored Oct 12, 2023
1 parent 0eaa61a commit 98d0810
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 178 deletions.
3 changes: 1 addition & 2 deletions docs/book/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
[The Sway Programming Language](./index.md)

- [Introduction](./introduction/index.md)
- [Installation](./introduction/installation.md)
- [Sway Quickstart](./introduction/sway_quickstart.md)
- [Getting Started](./introduction/getting_started.md)
- [The Fuel Toolchain](./introduction/fuel_toolchain.md)
- [A Forc Project](./introduction/forc_project.md)
- [Standard Library](./introduction/standard_library.md)
Expand Down
2 changes: 1 addition & 1 deletion docs/book/src/introduction/fuel_toolchain.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The Sway Language Server `forc-lsp` is provided to expose features to IDEs. [Ins

## Sway Formatter (`forc-fmt`)

A canonical formatter is provided with `forc-fmt`. [Installation instructions](./installation.md). It can be run manually with
A canonical formatter is provided with `forc-fmt`. [Installation instructions](./getting_started.md). It can be run manually with

```sh
forc fmt
Expand Down
9 changes: 9 additions & 0 deletions docs/book/src/introduction/getting_started.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Getting Started

## Installing the `Fuel` toolchain

Please visit the Fuel [Installation Guide](https://docs.fuel.network/guides/installation) to install the Fuel toolchain binaries and prerequisites.

## Sway Quickstart

Check out the [Developer Quickstart Guide](https://docs.fuel.network/guides/quickstart/) for a step-by-step guide on building a fullstack dapp on Fuel. The guide will walk you through writing a smart contract, setting up a wallet, and building a frontend to interact with your contract.
3 changes: 1 addition & 2 deletions docs/book/src/introduction/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,7 @@

To get started with Forc and Sway smart contract development, install the Fuel toolchain and Fuel full node and set up your first project.

- [Installation](./installation.md)
- [Sway Quickstart](./sway_quickstart.md)
- [Getting Started](./getting_started.md)
- [The Fuel Toolchain](./fuel_toolchain.md)
- [A Forc Project](./forc_project.md)
- [Standard Library](./standard_library.md)
170 changes: 0 additions & 170 deletions docs/book/src/introduction/installation.md

This file was deleted.

3 changes: 0 additions & 3 deletions docs/book/src/introduction/sway_quickstart.md

This file was deleted.

0 comments on commit 98d0810

Please sign in to comment.