Skip to content

Commit

Permalink
Merge pull request #364 from invariant-labs/get-started-refactor
Browse files Browse the repository at this point in the history
Image and descrption refactor
  • Loading branch information
wojciech-cichocki authored Jun 11, 2024
2 parents 581dc93 + dfce1af commit 2796120
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 8 deletions.
17 changes: 11 additions & 6 deletions docs/docs/eclipse/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,15 @@ title: Get Started
slug: /eclipse/get_started
---

This guide will walk you through the essential steps to get started on our [platform](https://eclipse.invariant.app/). From connecting your wallet and requesting an airdrop to adding a liquidity position, swapping tokens, claiming fees, and closing your position. If you encounter any issues or have questions, feel free to join our community on [Invariant's Discord](https://discord.gg/w6hTeWTJvG) for support. Please note that this walkthrough is on the testnet.

### Connect your wallet

To begin using Invariant, you'll need to [connect your wallet](/docs/eclipse/user_guide/how_to_connect_your_wallet). Follow these steps:

- Click on the "Connect wallet" button at the top right corner of the page.

![wallet connection](/img/docs/app/connect_wallet.png)
![wallet connection](/img/docs/app/eclipse_connect_wallet.png)

- Select your wallet provider (e.g., Salmon).

Expand All @@ -22,11 +24,11 @@ To begin using Invariant, you'll need to [connect your wallet](/docs/eclipse/use

### Request airdrop

- Click on the [Faucet](/docs/eclipse/user_guide/faucet) button in the header.
- Click on the [Faucet](/docs/eclipse/user_guide/faucet) button in the header. A modal with a captcha will appear on the screen after clicking the button.

![Faucet](/img/docs/app/eclipse_faucet.png)

- Solve captcha
- Solve captcha in order to acquire airdrop

![Captcha](/img/docs/app/eclipse_captcha.png)

Expand All @@ -40,7 +42,7 @@ To begin using Invariant, you'll need to [connect your wallet](/docs/eclipse/use

- Go to the Pool tab and click on Add Position button.

![Add position button](/img/docs/app/add_position.png)
![Add position button](/img/docs/app/eclipse_add_position_pool.png)

- Choose the tokens you want to provide liquidity for.

Expand All @@ -57,6 +59,9 @@ To begin using Invariant, you'll need to [connect your wallet](/docs/eclipse/use
### Swap tokens

- Navigate to [Swap](/docs/eclipse/user_guide/how_to_swap) page.

![Swap navigate](/img/docs/app/eclipse_swap_navigate.png)

- Select the token you want to swap from and the token you want to swap to.
- Enter the amount you wish to swap.

Expand All @@ -70,7 +75,7 @@ As a liquidity provider, you can [claim your earned fees](/docs/eclipse/user_gui

- Navigate to the "Pool" section and open the position from which you want to claim fees.

![Position view](/img/docs/app/eclipse_position_view.png)
![Position view](/img/docs/app/eclipse_position_navigate.png)

- Click on "Claim Fee" to initiate the transaction.

Expand All @@ -83,7 +88,7 @@ As a liquidity provider, you can [claim your earned fees](/docs/eclipse/user_gui

- Navigate to the "Pool" section and open the position which you want to [close](/docs/eclipse/user_guide/how_to_remove_liquidity).

![Position view](/img/docs/app/eclipse_position_view.png)
![Position view](/img/docs/app/eclipse_position_navigate.png)

- Click "Close Position" and confirm the transaction in your wallet. Deposited tokens as well as unclaimed fees will be transferred to your wallet

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/eclipse/user_guide/how_to_connect_your_wallet.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Before engaging with Invariant, it's imperative to initiate the process by conne

1. Start by locating the **Connect wallet** button positioned at the top-right corner of the screen. You'll find this button displayed in other areas throughout the app where connecting the wallet is necessary.

![wallet connection](/img/docs/app/eclipse_wallets.png)
![wallet connection](/img/docs/app/eclipse_connect_wallet.png)

2. Upon clicking **Connect wallet**, you'll be prompted to choose a supported wallet that operates on the Eclipse blockchain. This ensures seamless integration with Invariant. You have the flexibility to select a wallet from the list of detected options or opt to scan the QR code provided by Nightly wallet, which we highly recommend.

![wallet list](/img/docs/app/wallet-choice.png)
![wallet list](/img/docs/app/eclipse_wallets.png)

If you don't have a wallet yet, we recommend choosing one from the following options:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/docs/app/eclipse_faucet.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/docs/app/eclipse_wallet_connected.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/static/img/docs/app/eclipse_wallets.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2796120

Please sign in to comment.