Skip to content

Commit

Permalink
chore: update book
Browse files Browse the repository at this point in the history
  • Loading branch information
Darlington02 committed May 25, 2024
1 parent 8fcd448 commit ee25854
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 16 deletions.
1 change: 0 additions & 1 deletion docs/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@
- [Display account balance](./chapter_3/subchapter_5.md)
- [Switch/display network](./chapter_3/subchapter_6.md)
- [App Light/Dark mode](./chapter_3/subchapter_7.md)
- [Burner wallet UI](./chapter_3/subchapter_8.md)
- [Chapter 4](./chapter_4.md)
- [Chapter 5](./chapter_5.md)
- [Chapter 6](./chapter_6.md)
Expand Down
16 changes: 9 additions & 7 deletions docs/src/chapter_3/subchapter_1.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,23 @@
# Connect Button

A custom connect button is available and is found at the header of the page which aids in the connection of a user's Starknet wallet to the dapp. Once clicked, a custom wallet modal pops up at the center of the screen.
A custom connect button is located in the header of the page, facilitating the connection of a user's Starknet wallet to the dapp. When clicked, a custom wallet modal appears at the center of the screen.

# Connect Wallet Modal
## Connect Wallet Modal

The connect wallet modal is a UI component that appears once the connect button is clicked. This component consists of an overlay which spans across the screen and a modal that is located at the center of the overlay. This component's primary function is to allow users select the wallet they wish to use to connect to the Dapp.
The connect wallet modal is a UI component that appears when the connect button is clicked. This component consists of an overlay that spans across the screen and a modal positioned at the center of the overlay. Its primary function is to allow users to select the wallet they wish to use to connect to the dapp.

The modal is divided into two parts. The left side of the modal lists some popular starknet wallets available to be used such as;
The modal is divided into two parts. The left side lists some popular Starknet wallets available for use, such as:

1. Argent X
2. Braavos
3. Argent Web Wallet
4. Argent(mobile).
4. Argent (mobile)
5. Bitget
6. OKX

When any of these are clicked, a modal from that particular wallet (if installed) is opened and the user then unlocks their wallet and instantiates the connection. If the connection is successful, the user is then redirected to the dapp.
When any of these options are clicked, a modal from the selected wallet (if installed) opens, allowing the user to unlock their wallet and initiate the connection. If the connection is successful, the user is then redirected to the dapp.

The right side of the modal helps as an aid to educate the user on how wallet connections work.
The right side of the modal serves to educate the user on how wallet connections work.

## Import

Expand Down
2 changes: 1 addition & 1 deletion docs/src/chapter_3/subchapter_2.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Address bar (Displays StarknetID)

The Address bar displays the address of the connected account. If the connected wallet has a Starknet.id, the Address bar will display the Starknet.id profile picture and name, else it shows a Blockies-generated image representation of the connected address along with a shortened version of the address.
The Address bar displays the address of the connected account. If the connected wallet has a Starknet.id, the Address bar will display the Starknet.id profile picture and name. Otherwise, it shows a Blockies-generated image representation of the connected address along with a shortened version of the address.

## Import

Expand Down
10 changes: 5 additions & 5 deletions docs/src/chapter_3/subchapter_3.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Transactions List

This is a component that shows the list of transactions done by the connected wallet.
This component displays the list of transactions performed by the connected wallet.

Each transaction item shows the:
Each transaction item shows the following:

1. Transaction status: which is represented by icons. The status of a transaction can be one of the following; completed, pending, Failed.
1. Transaction status: represented by icons. The status of a transaction can be one of the following: completed, pending, or failed.
2. Transaction ID
3. Transaction Description
3. Transaction description
4. Transaction time and date
5. "See transaction": which redirects the user to view the transaction on the Starkscan block explorer where they can access more information on the transaction.
5. "See transaction": redirects the user to view the transaction on the Starkscan block explorer, where they can access more information about the transaction.

## Import

Expand Down
2 changes: 1 addition & 1 deletion docs/src/chapter_3/subchapter_4.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# User modal

This modal hosts a copy button for copying the address of the connected wallet, a disconnect button for disconnecting the connected wallet, and displays the ETH/STRK balance of the connected wallet. This modal can be accessed by clicking on the address bar component.
This modal contains a copy button for copying the address of the connected wallet, a disconnect button for disconnecting the wallet, and displays the ETH/STRK balance of the connected wallet. You can access this modal by clicking on the address bar component.

## Import

Expand Down
1 change: 0 additions & 1 deletion docs/src/chapter_3/subchapter_8.md

This file was deleted.

0 comments on commit ee25854

Please sign in to comment.