Skip to content

Commit

Permalink
Merge pull request #166 from rsksmart/docs/maintenance-06
Browse files Browse the repository at this point in the history
Docs: Maintenance updates for November
  • Loading branch information
owans authored Nov 27, 2024
2 parents e77fe01 + 5024281 commit 658ea5a
Show file tree
Hide file tree
Showing 17 changed files with 40 additions and 31 deletions.
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
## Testing

* Describe how you tested the changes to ensure they are correct and do not introduce new issues. See how to test build outputs and broken links in [README.md](/README.md) using the `yarn build`command.
* Use N/A, if not applicable

## Checklist

Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,18 +252,18 @@ Choose the most appropriate one.

Next, the description should be automatically populated from a template.
Fill it in accordingly.
Note that **What** and **Why** sections are compulsory,
and the **Refs** section is optional.
Note that **Describe the bug**, **Reproduce**, **Device Type**, and **Screenshots** sections are compulsory,
and the **Addditional Contest** section is optional.

### Pull Requests
### Pull Requests (PR)

You can also contribute to the Developer's portal by sending a
[PR](https://github.com/rsksmart/devportal/pulls).

When you open a pull request,
the description should be automatically populated from a template.
Fill it in accordingly.
Note that **What** and **Why** sections are compulsory,
and the **Refs** section is optional.
Note that **Title** and **Description**, **screenshot**, and **checklist** sections are compulsory,
and the **testing**, and **Refs** sections are optional.

> Note to run `yarn build` to test the build output of your branch prior to creating a new pull request, or pushing more commits to an existing one. Don't introduce any regressions!
4 changes: 1 addition & 3 deletions docs/02-developers/02-requirements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ description: "Minimum hardware requirements for Rootstock."
---

This guide provides clear instructions for developers on the supported Solidity versions and the necessary configurations needed to ensure your smart contracts are deployed on the Rootstock network.



:::tip[Hackathons & Workshops]

Expand Down Expand Up @@ -66,7 +64,7 @@ Set up your wallet to connect with Rootstock networks:

- **MetaMask Integration:**
- Configure MetaMask with the necessary values to connect to the Rootstock Mainnet or Testnet.
- Refer to the [MetaMask Wallet Configuration](#configure-metamask-wallet) guide for detailed steps.
- Refer to the [MetaMask Wallet Configuration](/dev-tools/wallets/metamask/) guide for detailed steps.

- **Derivation Paths:**
- Use these paths for BIP-44-compatible wallets:
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/ape.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
section_position: 400
sidebar_label: Getting Started with Ape
sidebar_label: Ape
title: Getting Started with Ape
description: 'How to compile, deploy, and intereact with smart contracts with Ape on Rootstock'
tags: [rsk, ape, apeworx, developers, developer tools, tRBTC, rootstock, testing, dApps, smart contracts]
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
section_position: 400
sidebar_label: Rootstock Dynamic Starter Kit
sidebar_label: Dynamic
title: Dynamic Starter Kit
description: 'The Rootstock Dynamic Starter Kit uses the wagmi library for faster integration of Web3 features into a Next.js application. Using wagmi hooks, you can connect to wallets, retrieve balances, transfer tokens, and sign messages. '
description: "The Rootstock Dynamic Starter Kit uses the wagmi library for faster integration of Web3 features into a Next.js application. Using wagmi hooks, you can connect to wallets, retrieve balances, transfer tokens, and sign messages."
tags: [rsk, Dynamic, developers, Kit, rootstock, Starter, dApps, smart contracts]
---

The Rootstock Dynamic Starter Kit uses the `wagmi` library for faster integration of Web3 features into a Next.js application. Using `wagmi` hooks, you can connect to wallets, retrieve balances, transfer tokens, and sign messages.
The Rootstock Dynamic Starter Kit uses the `Wagmi` library for faster integration of Web3 features into a Next.js application. Using `Wagmi` hooks, you can connect to wallets, retrieve balances, transfer tokens, and sign messages.

At the end of this guide, you’ll know how to set up and configure a Next.js project with Web3 support, connect to different wallets, retrieve data from the blockchain, send transactions to transfer tokens or interact with smart contracts, and securely sign messages to verify user identities.

Expand Down Expand Up @@ -179,7 +179,7 @@ Visit [http://localhost:3000](http://localhost:3000) in your browser to view you
<Steps>
<Step title="Connect Wallet">
* Use the `DynamicWidget` component for connecting to a wallet through options like MetaMask or WalletConnect. You can also offer social login options for enhanced accessibility.
* Once logged in you will see a similar image like this
* Once logged in, you will see a similar image like this

<img src="/img/developers/quickstart/dynamic-starter-kit/image3.png" alt="Connect wallet using DynamicWidget component"/>

Expand Down Expand Up @@ -208,8 +208,8 @@ Visit [http://localhost:3000](http://localhost:3000) in your browser to view you
</Steps>
<br/>

By the end of this guide, you’ve learned how to integrate Web3 features into a **Next.js** app using the **Dynamic Starter Kit for Rootstock**. With **wagmi hooks**, you can easily connect wallets, manage token balances, send tokens, and sign messages directly within your application.
By the end of this guide, we learned how to integrate Web3 features into a **Next.js** app using the **Dynamic Starter Kit for Rootstock**. With **wagmi hooks**, we can easily connect wallets, manage token balances, send tokens, and sign messages directly within your application.

You’ve also seen how **Dynamic’s embedded wallet** simplifies the user experience by eliminating the need for external wallet apps. This integration makes Web3 more accessible, especially for beginners to the blockchain. With support for popular wallets like **MetaMask** and **WalletConnect**, and pre-configuration for the **Rootstock Testnet**, you now have a secure, user-friendly foundation to build and test your Web3 applications.
We’ve also learnt how **Dynamic’s embedded wallet** simplifies the user experience by eliminating the need for external wallet apps. This integration makes Web3 more accessible, especially for beginners to the blockchain. With support for popular wallets like **MetaMask** and **WalletConnect**, and pre-configuration for the **Rootstock Testnet**, developers now have a secure, user-friendly foundation to build and test their Web3 applications.

You can view the complete project and code on [Github](https://github.com/rsksmart/rootstock-dynamic).
View the complete project and code on [Github](https://github.com/rsksmart/rootstock-dynamic).
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/foundry.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Rootstock Foundry Starter kit
sidebar_label: Foundry
sidebar_position: 500
title: Rootstock Foundry Starter kit
description: 'Whether you are a seasoned developer or just starting your journey into smart contract development, the foundry starter kit provides a solid foundation for building decentralized applications (dApps) on the Rootstock network.'
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/hardhat.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Rootstock Hardhat Starter Kit
sidebar_label: Hardhat
sidebar_position: 400
title: Rootstock Hardhat Starter Kit
description: 'Whether you are a seasoned developer or just starting your journey into smart contract development, the hardhat starter kit provides a solid foundation for building decentralized applications (dApps) on the Rootstock network.'
Expand Down
11 changes: 10 additions & 1 deletion docs/02-developers/04-quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,15 @@ values={[
{label: 'Ape', value: 'ape'},
{label: 'Port to Rootstock', value: 'port-dapps'}
]}>
<FilterItem
value="dynamic, wagmi, advanced"
title="Dynamic Starter Kit"
subtitle="quickstart"
color="orange"
linkHref="/developers/quickstart/dynamic/"
linkTitle="Use the Kit"
description="The Dynamic Starter Kit uses the Wagmi library for faster integration of Web3 features into a Next.js application."
/>
<FilterItem
value="wagmi, beginner"
title="Wagmi Starter Kit"
Expand Down Expand Up @@ -53,7 +62,7 @@ values={[
color="orange"
linkHref="/developers/quickstart/rootstock-etherspot/"
linkTitle="Use the Kit"
description="Account Abstraction Starter dApp using Etherspot."
description="Account Abstraction Starter Kit using Etherspot."
/>
<FilterItem
value="advanced"
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/remix.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer
sidebar_label: Remix
sidebar_position: 600
title: Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer
description: 'In this guide, we will use the Remix IDE to write, compile, deploy, interact and verify a smart contract on the Rootstock Explorer.'
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/rootstock-etherspot.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Account Abstraction using Etherspot Prime SDK
sidebar_label: AA with Etherspot
sidebar_position: 600
title: Account Abstraction using Etherspot Prime SDK
description: 'In this guide, you will learn how to use the Etherspot Prime SDK to deploy an Account Abstraction dApp on the Rootstock network. By following these steps, you will empower your users to interact with your dApp without managing private keys directly.'
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/wagmi.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Rootstock Wagmi Starter Kit
sidebar_label: Wagmi
sidebar_position: 300
title: Rootstock Wagmi Starter Kit
description: 'The Rootstock Wagmi Starter Kit provides a solid foundation for developing decentralized applications (dApps) on the Rootstock blockchain. It streamlines development by leveraging the React, Wagmi, and Shadcn libraries.'
Expand Down
2 changes: 1 addition & 1 deletion docs/02-developers/04-quickstart/web3-python.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
sidebar_label: Deploy and Interact with a Smart Contract using Web3.py
sidebar_label: Web3.py
sidebar_position: 200
title: Deploy and Interact with a Smart Contract using Web3.py
description: 'Deploy and Interact with a Smart Contract Using Web3.py.'
Expand Down
8 changes: 4 additions & 4 deletions docs/02-developers/05-smart-contracts/contract-addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,11 +17,11 @@ For info on derivation paths, see [Account based addresses](/concepts/account-ba

## List of Contract Addresses

| Symbol | Name | Token Standard | Network | Contract Address |
|---|---|---|---| ---|
| [RIF](/concepts/rif-suite/token) | RIF Token | ERC677 | Rootstock | [0x2acc95...](https://explorer.rootstock.io/address/0x2acc95758f8b5f583470ba265eb685a8f45fc9d5) |
| Symbol | Name | Token Standard | Network | Contract Address (Mainnet) | Contract Address (Testnet) |
|---|---|---|---| ---| ---|
| [RIF](/concepts/rif-suite/token) | RIF Token | ERC677 | Rootstock | [0x2acc95...](https://explorer.rootstock.io/address/0x2acc95758f8b5f583470ba265eb685a8f45fc9d5) | [0x19f646...](https://explorer.testnet.rootstock.io/address/0x19f64674d8a5b4e652319f5e239efd3bc969a1fe)
| DOC | [Dollar on Chain](https://moneyonchain.com/doc-bitcoin-stablecoin/) | ERC20 | Rootstock | [0xe70069...](https://explorer.rootstock.io/address/0xe700691da7b9851f2f35f8b8182c69c53ccad9db) |
| USDRIF | [RIF US Dollar](https://rifonchain.com/) | ERC20, ERC165, ERC1967 | Rootstock | [0x3a15461...](https://explorer.rootstock.io/address/0x3a15461d8ae0f0fb5fa2629e9da7d66a794a6e37) |
| USDRIF | [RIF US Dollar](https://rifonchain.com/) | ERC20, ERC165, ERC1967 | Rootstock | [0x3a15461...](https://explorer.rootstock.io/address/0x3a15461d8ae0f0fb5fa2629e9da7d66a794a6e37) | [0x8dbf3...](https://explorer.testnet.rootstock.io/address/0x8dbf326e12a9fF37ED6DDF75adA548C2640A6482)
| RIFP | [RIFPro](https://rif.moneyonchain.com/metrics) | ERC20 | Rootstock | [0xf4d27c5...](https://explorer.rootstock.io/address/0xf4d27c56595ed59b66cc7f03cff5193e4bd74a61) |
| BPro | [BitPro](https://moneyonchain.com/bpro-income-for-bitcoin-holders/) | ERC20 | Rootstock | [0x440cd83...](https://explorer.rootstock.io/address/0x440cd83c160de5c96ddb20246815ea44c7abbca8) |
| BTCX | [BTCX](https://moneyonchain.com/btcx-leveraged-bitcoin/) | | Rootstock | [0xf773b5...](https://explorer.rootstock.io/address/0xf773b590af754d597770937fa8ea7abdf2668370) |
Expand Down
2 changes: 1 addition & 1 deletion docs/04-resources/02-contribute/hacktivator-program.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,7 +223,7 @@ Your contributions can cover any of the following Rootstock themes:
#### 👉 Educational Content Criteria & Guidelines:

* Educational content should be targeted towards developers looking to build on Rootstock or understand its integration with Bitcoin.
* Blogs, tutorials (written or video), and developer guides should be original, accurate, and provide actionable insights.
* Blogs, tutorials (written or video), and developer guides should be original content created after the program launch on November 11th (not previously published elsewhere), is accurate, and provides actionable insights. Please share your content via Google Drive by providing the URL on the submission form (link below).
* Content must help other developers navigate and work with Rootstock, deploy smart contracts, use compatible tools, SDKs, and libraries, and or integrate protocols on Rootstock.
* Contributions for Rootstock Technical documentation should be submitted as a Pull Request (PR) directly on the [DevPortal Repo](https://github.com/rsksmart/devportal/pulls), and the PR link should be submitted via the [Google form](https://forms.gle/aF9pFMfRyoygfzJWA). Ensure to use the label **“hacktivator-program”** on the PR and properly describe your PR using the template.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ This variable specifies the address of the Airdrop Manager smart contract. To en

:::info[Info]

For detailed instructions on obtaining the Airdrop Manager address, please refer to the [Deployment](/resources/guides/runes-rootstock/airdrop-giveaway-machine/deploy-airdrop-machine.md) section.
For detailed instructions on obtaining the Airdrop Manager address, please refer to the [Deployment](/resources/guides/runes-rootstock/airdrop-giveaway-machine/deploy-airdrop-machine/) section.

:::

Expand Down
2 changes: 1 addition & 1 deletion src/components/Homepage/HomepageSectionGuides/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ const data = {
],
},
{
title: 'Become a Node Miner',
title: 'Become a Merged Miner',
color: 'green',
description: (
<>
Expand Down
3 changes: 2 additions & 1 deletion vercel.json
Original file line number Diff line number Diff line change
Expand Up @@ -639,6 +639,7 @@
{"source" : "/developers/quickstart/alchemy/", "destination" : "/developers/rpc-api/alchemy/"},
{"source" : "/developers/rpc-api/setup/", "destination" : "/developers/rpc-api/rootstock/setup/"},
{"source" : "/developers/smart-contracts/eas/", "destination" : "/dev-tools/attestations/eas/"},
{"source" : "/developers/smart-contracts/eas/overview/", "destination" : "/dev-tools/attestations/eas/"}
{"source" : "/developers/smart-contracts/eas/overview/", "destination" : "/dev-tools/attestations/eas/"},
{"source" : "/developers/quickstart/dynamic-starter-kit/", "destination" : "/developers/quickstart/dynamic/"}
]
}

0 comments on commit 658ea5a

Please sign in to comment.