Skip to content

Commit 938b63a

Browse files
authored
Merge pull request #3 from status-im/feature/intro-content
Add Introduction & Quick Start Guide, Implement Translation Support, Fix CSS Bugs and Light Mode Styling
2 parents 640798f + 8d0db32 commit 938b63a

File tree

121 files changed

+3281
-100
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+3281
-100
lines changed

Jenkinsfile

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,7 @@ pipeline {
4545
-b deploy-master \
4646
-c docs.status.network \
4747
-p build
48-
""",
49-
pure: false
48+
"""
5049
)
5150
}
5251
}

README.md

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -77,26 +77,6 @@ docs/
7777
└── other/ # Additional resources
7878
```
7979

80-
### Style Guide
81-
82-
When contributing to the documentation, please follow these guidelines:
83-
84-
- Use clear, concise language
85-
- Include code examples where applicable
86-
- Add screenshots or diagrams for complex concepts
87-
- Follow the existing document structure
88-
- Use appropriate frontmatter for all markdown files
89-
90-
Example markdown frontmatter:
91-
```md
92-
---
93-
id: page-id
94-
title: Page Title
95-
description: Brief description of the page
96-
sidebar_position: 1
97-
---
98-
```
99-
10080
---
10181

10282
Made with ❤️ by the Status Network community
Lines changed: 84 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,84 @@
1-
# Add Status Network
1+
# Add Status Network
2+
3+
This guide shows how to add the **Status Network** to your wallet.
4+
5+
## Testnet
6+
7+
To add **Status Network Testnet** as a custom network to MetaMask:
8+
9+
1. **Open MetaMask**:
10+
11+
- Click on the MetaMask extension icon in your browser to open it.
12+
13+
2. **Access the Network Settings**:
14+
15+
- Click on the network selection dropdown at the top of the MetaMask window.
16+
17+
3. **Add a New Network**:
18+
19+
- Click on **"Add network"**.
20+
- In the new window, click on **"Add a network manually"**.
21+
22+
4. **Enter Network Details**:
23+
24+
- Fill in the following information:
25+
26+
| Name | Value |
27+
|------------------|------------------------------------------|
28+
| **Network Name** | Status Network Testnet |
29+
| **RPC URL** | |
30+
| **Chain ID** | |
31+
| **Currency Symbol** | `ETH` |
32+
| **Block Explorer URL** | |
33+
34+
5. **Save the Network**:
35+
36+
- Click **"Save"** to add the Status Network Testnet to your MetaMask wallet.
37+
38+
You should now be able to connect to the Status Network Testnet by selecting it from the network dropdown menu.
39+
40+
---
41+
42+
## Mobile Wallets
43+
44+
### Adding Status Network to MetaMask Mobile
45+
46+
1. **Open MetaMask Mobile App**:
47+
48+
- Launch the MetaMask app on your mobile device.
49+
50+
2. **Access Settings**:
51+
52+
- Tap on the hamburger menu (three horizontal lines) in the top left corner.
53+
- Select **"Settings"**.
54+
55+
3. **Add a New Network**:
56+
57+
- Tap on **"Networks"**.
58+
- Tap on **"Add Network"**.
59+
60+
4. **Enter Network Details**:
61+
62+
- Input the same network details as mentioned above for Testnet.
63+
64+
5. **Save the Network**:
65+
66+
- Tap **"Add"** to save the new network.
67+
68+
---
69+
70+
## Additional Information
71+
72+
- **Official Links**:
73+
74+
- [Status Network Website](https://status.network/)
75+
- [Status Network Documentation](https://docs.status.network/)
76+
- [Status Network Explorer](#)
77+
78+
- **Need Help?**
79+
80+
- If you encounter any issues, please join our [Community Discord](https://discord.gg/status_im).
81+
82+
---
83+
84+
By following this guide, you've successfully added the Status Network to your MetaMask wallet!
Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,12 @@
1-
# Network Details
1+
# Network Details
2+
3+
## Status Testnet
4+
5+
| Name | Value |
6+
|---------------------|-------|
7+
| **Network Name** | |
8+
| **RPC Endpoint** | |
9+
| **Chain ID** | |
10+
| **Currency Symbol** | |
11+
| **Block Explorer** | |
12+
| **Bridge** | |

docs/index.md

Lines changed: 21 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,24 @@ slug: /
55
sidebar_position: 1
66
---
77

8-
# Introducing Status Network
8+
# Welcome to Status Network
9+
10+
Welcome to **Status Network**, the crypto social playground that reimagines your blockchain experience! Built as an **EVM-equivalent Ethereum Layer 2 rollup** on [Linea's cutting-edge ZK-EVM technology](https://docs.linea.build/architecture), Status Network offers unique features that set us apart from other platforms.
11+
12+
## What Makes Us Unique?
13+
14+
### 💰 Native ETH and DAI Yield
15+
16+
Enjoy sustainable and attractive yields on your **ETH** and **DAI** assets! We offer native yield generation, a distinctive feature among Layer 2 solutions, allowing you to enhance your crypto holdings effortlessly while participating in the network.
17+
18+
### 🏆 Earn $AURA Tokens
19+
20+
Get rewarded for your engagement in **real time**! Participate in network activities and **stake $SNT** to earn **$AURA tokens**. The more you interact—be it through transactions, staking, or community involvement—the more influence you gain within our vibrant community. Your $AURA amplifies your voice in shaping the future of the network.
21+
22+
### 🔒 Privacy with a Playful Twist
23+
24+
Experience privacy features that are both **secure and fun**! We believe that privacy is a fundamental right and should be accessible to everyone without the complexity. Our user-friendly privacy tools make secure interactions enjoyable, breaking away from traditional notions of complicated privacy tech.
25+
26+
---
27+
28+
Join Status Network and be part of a unique, privacy-focused, and rewarding crypto community where **your active participation truly shapes the future**! Let's build the crypto playground together!

docs/introduction/quick-start.md

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,114 @@
1-
# Quick Start
1+
# Quick Start
2+
3+
In this section, we'll get you deploying a sample contract on **Status Network Testnet** in less than 10 minutes.
4+
5+
Let’s see how to deploy a smart contract on Status Network using the Remix IDE for simplicity.
6+
7+
## Get Everything Ready
8+
9+
Before getting started:
10+
11+
- **Add Status Network Testnet to MetaMask**:
12+
13+
Follow the [Status Network documentation](/general-info/add-status-network) for step-by-step instructions on how to add the Status Network testnet to MetaMask. You'll need the network's RPC URL, Chain ID, and other details.
14+
15+
- **Obtain Testnet Tokens**:
16+
17+
This guide assumes you have obtained testnet ETH on the Status Network. You can use the [Status Network Testnet Faucet](#) to request test tokens.
18+
19+
We are ready to get started!
20+
21+
## Remix & Sample Code
22+
23+
**Remix** is a no-setup tool for developing smart contracts. It’s easy to get started, allowing a simple deployment process, debugging, interacting with smart contracts, and more. It’s a great tool to test quick changes and interact with deployed smart contracts.
24+
25+
For the sake of this tutorial, we will be deploying the `SimpleStorage.sol` smart contract that comes as an example in Remix, but you can use any of your code.
26+
27+
Here's the sample code:
28+
29+
```solidity
30+
// SPDX-License-Identifier: MIT
31+
32+
pragma solidity ^0.8.24;
33+
34+
contract SimpleStorage {
35+
36+
uint256 number;
37+
38+
function store(uint256 num) public {
39+
number = num;
40+
}
41+
42+
function retrieve() public view returns (uint256) {
43+
return number;
44+
}
45+
}
46+
```
47+
48+
> **Note:** This contract lets you store a number and then read what that number is.
49+
50+
## Steps to Deploy
51+
52+
1. **Copy the Sample Code**:
53+
54+
- Copy the sample code and paste it into a new file named `SimpleStorage.sol` in Remix.
55+
56+
2. **Compile the Smart Contract**:
57+
58+
- Go to the **Solidity Compiler** tab (on the left sidebar).
59+
- Ensure the compiler version matches the pragma statement in your contract (`0.8.24`).
60+
- Click **"Compile SimpleStorage.sol"**.
61+
- You can enable **"Auto compile"** for automatic compilation whenever you change the contract code.
62+
63+
3. **Deploy the Smart Contract**:
64+
65+
- Switch to the **Deploy & Run Transactions** tab.
66+
- In the **"Environment"** dropdown menu, select **"Injected Provider - MetaMask"**. This connects Remix to your MetaMask wallet.
67+
- MetaMask may prompt you to connect to Remix. Confirm the connection.
68+
- Ensure that **Status Network Testnet** is selected in MetaMask.
69+
- Under **"Contract"**, make sure `SimpleStorage` is selected.
70+
- Click **"Deploy"**.
71+
- MetaMask will pop up, asking you to confirm the transaction.
72+
- Review the transaction details and click **"Confirm"**.
73+
- Wait for the transaction to be mined. You can track the status in Remix or MetaMask.
74+
75+
**CONGRATULATIONS!** You just deployed your first smart contract on Status Network.
76+
77+
## Interact with Your Deployed Smart Contract
78+
79+
1. **Access Deployed Contract**:
80+
81+
- In Remix, under the **"Deployed Contracts"** section, you'll see your deployed `SimpleStorage` contract.
82+
83+
2. **Store a Number**:
84+
85+
- Expand the deployed contract to view its functions.
86+
- In the **"store"** function input field, enter a number (e.g., `42`).
87+
- Click **"transact"**.
88+
- MetaMask will prompt you to confirm the transaction. Click **"Confirm"**.
89+
- Wait for the transaction to be confirmed.
90+
91+
3. **Retrieve the Number**:
92+
93+
- Click on the **"retrieve"** function.
94+
- The stored number will display below the button.
95+
96+
## Next Steps
97+
98+
- **Get Support**:
99+
100+
- If you encounter any issues or have questions, join the community channels for assistance.
101+
102+
## Summary
103+
104+
You've successfully:
105+
106+
- Set up your environment to interact with Status Network Testnet.
107+
- Deployed a smart contract using Remix IDE and MetaMask.
108+
- Interacted with your deployed contract by storing and retrieving a number.
109+
110+
---
111+
112+
If you want to dive deeper, consider exploring more complex smart contracts. Checkout more tutorials [here](/tutorials/ethers-tutorial).
113+
114+
**Happy Coding!**

0 commit comments

Comments
 (0)