Update docs + lint w/ markdownlint

README.md

@@ -1,10 +1,10 @@
 # Fuel Indexer
 
-<img src="https://miro.medium.com/fit/c/176/176/1*W-1e0zVhcLui4u-ci2e-Fg.png">
+![Fuel Logo](./docs/img/fuel.png "Fuel Logo")
 
 [![build](https://github.com/FuelLabs/fuel-indexer/actions/workflows/ci.yml/badge.svg)](https://github.com/FuelLabs/fuel-indexer/actions/workflows/ci.yml)
 [![crates.io](https://img.shields.io/crates/v/fuel-indexer?label=latest)](https://crates.io/crates/fuel-indexer)
 [![docs](https://docs.rs/fuel-indexer/badge.svg)](https://docs.rs/fuel-indexer/)
 [![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)
 
-Fuel Indexer uses WASM to index transactions and state within a fuel network, allowing for high-performance read-only access to the blockchain for advanced dApp use-cases. For more info on how to get started with Fuel Indexer, [read the book](https://fuellabs.github.io/fuel-indexer/latest/index.html)
+Fuel Indexer uses WASM to index transactions and state within a fuel network, allowing for high-performance read-only access to the blockchain for advanced dApp use-cases. For more info on how to get started with Fuel Indexer, [read the book](https://fuellabs.github.io/fuel-indexer/latest/index.html)

docs/book.toml

@@ -9,4 +9,4 @@ title = "The Fuel Indexer Service"
 git-repository-url = "https://github.com/FuelLabs/fuel-indexer"
 
 [rust]
-edition = "2021"
+edition = "2021"

docs/src/README.md

@@ -1,10 +1,27 @@
 # Fuel Indexer
 
-<img src="https://miro.medium.com/fit/c/176/176/1*W-1e0zVhcLui4u-ci2e-Fg.png">
+![Fuel Logo](./../img/fuel.png "Fuel Logo")
 
-[![build](https://github.com/FuelLabs/fuel-indexer/actions/workflows/ci.yml/badge.svg)](https://github.com/FuelLabs/fuel-indexer/actions/workflows/ci.yml)
-[![crates.io](https://img.shields.io/crates/v/fuel-indexer?label=latest)](https://crates.io/crates/fuel-indexer)
-[![docs](https://docs.rs/fuel-indexer/badge.svg)](https://docs.rs/fuel-indexer/)
-[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)
+Fuel Indexer uses WASM to index transactions and state within a fuel network, allowing for high-performance read-only access to the blockchain for advanced dApp use-cases. For more info on how to get started with Fuel Indexer, [read the book](https://fuellabs.github.io/fuel-indexer/latest/index.html)
 
-Fuel Indexer uses WASM to index transactions and state within a fuel network, allowing for high-performance read-only access to the blockchain for advanced dApp use-cases. For more info on how to get started with Fuel Indexer, [read the book](https://fuellabs.github.io/fuel-indexer/latest/index.html)
+## Documentation
+
+### Building From Source
+
+Install `mdbook` and then open a new terminal session in order to run the subsequent commands
+
+```sh
+cargo install mdbook
+```
+
+To build book:
+
+```sh
+mdbook build
+```
+
+To serve locally:
+
+```sh
+mdbook serve
+```

docs/src/SUMMARY.md

@@ -3,5 +3,5 @@
 [The Fuel Indexer](./README.md)
 
 - [Getting Started](./getting-started/index.md)
-    - [Setting up](./getting-started/setup.md)
-    - [Basic usage](./getting-started/basics.md)
+  - [Setting up](./getting-started/setup.md)
+  - [Basic usage](./getting-started/basics.md)

docs/src/getting-started/basics.md

@@ -1,13 +1,17 @@
-## Basic usage of the Fuel Indexer
+# Basic usage of the Fuel Indexer
+
+## Instantiating a Fuel client
 
-### Instantiating a Fuel client
 Start a local Fuel node in the background
+
 ```bash
 fuel-core --db-type in-memory &
 ```
 
-### Instantiating a Fuel Indexer
+## Instantiating a Fuel Indexer
+
 Start the Fuel Indexer service with a reference to your Fuel node
+
 ```bash
 RUST_LOG=debug cargo run --bin indexer
-```
+```

docs/src/getting-started/setup.md

@@ -1,17 +1,22 @@
 # Setup instructions for the Fuel SDK
 
-
 ## What you will need on your machine
 
 - Rust 2021 ([see here](https://doc.rust-lang.org/cargo/getting-started/installation.html))
 - A clone of the `fuel-indexer` repository:
+
 ```sh
+
 git clone https://github.com/FuelLabs/fuel-indexer
+
 ```
 
 - Install the following `cargo` crates:
+
 ```sh
+
 cargo install forc fuel-core
+
 ```
 
 - `forc` is the crate that holds the Sway language and Fuel's equivalent of `cargo`
@@ -21,28 +26,31 @@ cargo install forc fuel-core
 
 There are several system requirements including llvm, clang and postgres.
 
-
 ### Ubuntu
+
 ```bash
 apt update
 apt install -y cmake pkg-config libssl-dev git gcc build-essential git clang libclang-dev llvm libpq-dev
 ```
 
 ### MacOS
+
 ```bash
 brew update
 brew install openssl cmake llvm libpq postgresql
 ```
 
 ### Debian
+
 ```bash
 apt update
 apt install -y cmake pkg-config libssl-dev git gcc build-essential git clang libclang-dev llvm libpq-dev
 ```
 
 ### Arch
+
 ```bash
 pacman -Syu --needed --noconfirm cmake gcc openssl-1.0 pkgconf git clang llvm11 llvm11-libs postgresql-libs
 export OPENSSL_LIB_DIR="/usr/lib/openssl-1.0";
 export OPENSSL_INCLUDE_DIR="/usr/include/openssl-1.0"
-```
+```