Merge pull request #98 from MarvyNwaokobia/features-doc-v3

chore: effected requested doc changes

docs/src/SUMMARY.md

@@ -13,6 +13,12 @@
   - [Switch/display network](./chapter_3/subchapter_6.md)
   - [App Light/Dark mode](./chapter_3/subchapter_7.md)
 - [Chapter 4](./chapter_4.md)
+  - [Deployer](./chapter_4/subchapter_1.md)
+  - [Burner](./chapter_4/subchapter_2.md)
+  - [Faucet](./chapter_4/subchapter_3.md)
+  - [Wikipedia](./chapter_4/subchapter_4.md)
+  - [Converter](./chapter_4/subchapter_5.md)
+  - [Address Book](./chapter_4/subchapter_6.md)
 - [Chapter 5](./chapter_5.md)
 - [Chapter 6](./chapter_6.md)
 - [Chapter 7](./chapter_7.md)

docs/src/chapter_4.md

@@ -1,3 +1,10 @@
 # Tour Guide
 
-A tour guide/explanation/breakdown of the different features [Deployer, Burner, Faucet, Wikipedia, Converter]
+Starknet Scaffold provides a suite of tools and features aimed at simplifying your development experience. This section provides insight on how to make use of the various features available.
+
+1. [Deployer](./chapter_4/subchapter_1.md)
+2. [Burner](./chapter_4/subchapter_2.md)
+3. [Faucet](./chapter_4/subchapter_3.md)
+4. [Wikipedia](./chapter_4/subchapter_4.md)
+5. [Converter](./chapter_4/subchapter_5.md)
+6. [Address Book](./chapter_4/subchapter_6.md)

docs/src/chapter_4/subchapter_1.md

@@ -0,0 +1,14 @@
+# Deployer
+
+The scaffold deployer is a simple tool for seamlessly declaring and deploying smart contracts to Starknet testnet and mainnet.
+
+This tools interface consists of two sections; the declare and deploy section.
+
+## Declare section
+
+This section takes in the Contract Class JSON file (Sierra) and the Compiled Contract Class JSON file (CASM), then declares the contract.
+Once declared, a class hash is returned which can be used to deploy the contract.
+
+## Deploy section
+
+This section takes in the declared class hash and its constructor arguments, then deploys the contract.

docs/src/chapter_4/subchapter_2.md

@@ -0,0 +1,15 @@
+# Burner Wallet
+
+The burner wallet tool enables users to generate burner wallets which are temporary wallets that can be generated and used during the course of development. Burner wallets are only supported on the Sepolia network and a user can only only generate a maximum of five wallets at a time.
+
+A generated wallet UI gives us information such as ETH and STRK balance and address. The burner wallet can be funded using the [Faucet](subchapter_3.md) tool.
+
+In order for the generated burner wallet to be used, it has to be connected. After connection, the user can use it for the following;
+
+1. Transfer of tokens(ETH/STRK):
+   Transfer tokens by inputting the recipient address and amount.
+
+2. Execute smart contract calls:
+   The generated wallet can execute functions from other smart contracts by inputting the contract address, function name and arguments.
+
+The user can also clear all generated wallets.

docs/src/chapter_4/subchapter_3.md

@@ -0,0 +1,3 @@
+# Faucet
+
+This is sepETH/sepSTRK faucet tool for claiming ETH/STRK sepolia testnet tokens. In order to use it, the user types in the wallet address and specifies the test token they wish to receive then they send a request. This takes some seconds to reflect. This tool can be used to fund generated burner wallets.

docs/src/chapter_4/subchapter_4.md

@@ -0,0 +1,12 @@
+# Wikipedia
+
+The wikipedia tool is a collection of Starknet/Cairo learning resources in the ecosystem. These resources are in a tabular form which is paginated and sortable.
+
+The columns of the table are;
+
+1. Name: name of the resource.
+2. Description: A short description of the tool mentioned.
+3. Status: States whether the tool/resource is up to date or not.
+4. URL: A link to the tool/resource.
+
+This tool has a search functionality to easily find resources.

docs/src/chapter_4/subchapter_5.md

@@ -0,0 +1,3 @@
+# Converter
+
+A collection of utility functions for Starknet related conversions. This tool works by inputting a value you wish to convert after you are given the felt, hex, string, felt array, selector, u256, big3 equivalent that can be used anywhere else.

docs/src/chapter_4/subchapter_6.md

@@ -0,0 +1,3 @@
+# Address Book
+
+This is a tool that lists all relevant contract addresses within the starknet ecosystem.