Skip to content

Commit

Permalink
Ensure consistency in naming and style, fix broken links
Browse files Browse the repository at this point in the history
  • Loading branch information
owans committed Oct 30, 2024
1 parent a878914 commit f8d5482
Show file tree
Hide file tree
Showing 23 changed files with 65 additions and 179 deletions.
2 changes: 1 addition & 1 deletion docs/02-developers/02-requirements/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Participating in a Rootstock hackathon or Workshop? View the [Hackathon Resource
- Interact with Rootstock using the [RPC API](https://rpc.rootstock.io/)

:::tip[Get an API Key]
See how to setup the RPC API and get an [API Key](/developers/rpc-api/setup).
See how to setup the RPC API and get an [API Key](/developers/rpc-api/rootstock/setup/).
:::

## Connecting to a Wallet
Expand Down
127 changes: 0 additions & 127 deletions docs/02-developers/04-quickstart/alchemy.md

This file was deleted.

6 changes: 3 additions & 3 deletions docs/02-developers/04-quickstart/ape.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
section_position: 400
sidebar_label: Using Ape
title: Getting Started with Apeworx
sidebar_label: Getting Started with 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]
---

[Ape Framework](https://apeworx.io/framework/) is an easy-to-use Web3 development tool. Developers can compile, test, and interact with smart contracts all in one command line session. With its [modular plugin system](https://github.com/ApeWorX/ape?tab=readme-ov-file#plugin-system), Ape supports multiple contract languages and chains including Rootstock.
The [Ape Framework](https://apeworx.io/framework/) is an easy-to-use Web3 development tool. Developers can compile, test, and interact with smart contracts all in one command line session. With its [modular plugin system](https://github.com/ApeWorX/ape?tab=readme-ov-file#plugin-system), Ape supports multiple contract languages and chains including Rootstock.

In this guide, we will learn about the [Ape Framework](https://apeworx.io/framework/) and its benefits for smart contract development, how to setup your development environment, create a Ape project and execute a deployment script for Rootstock.

Expand Down
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: Using Foundry
sidebar_label: Rootstock Foundry Starter kit
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
4 changes: 2 additions & 2 deletions docs/02-developers/04-quickstart/hardhat.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Using Hardhat
sidebar_label: Rootstock Hardhat Starter Kit
sidebar_position: 400
title: Rootstock Hardhat Starter dApp
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.'
tags: [rsk, rootstock, tutorials, developers, hardhat, quick starts, dApps, smart contracts]
---
Expand Down
19 changes: 19 additions & 0 deletions docs/02-developers/04-quickstart/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ values={[
{label: 'Remix', value: 'remix'},
{label: 'Wagmi', value: 'wagmi'},
{label: 'On-chain data', value: 'data'},
{label: 'RPC API', value: 'rpc'},
{label: 'Ape', value: 'ape'},
{label: 'Port to Rootstock', value: 'port-dapps'}
]}>
Expand Down Expand Up @@ -117,4 +118,22 @@ values={[
linkTitle="Use Ape"
description="Learn how to compile, deploy, and intereact with smart contracts with Ape on Rootstock"
/>
<FilterItem
value="beginner, rpc"
title="Get Started with Rootstock RPC API"
subtitle="RPC API"
color="orange"
linkHref="/developers/rpc-api/rootstock/setup/"
linkTitle="Use the RPC API"
description="The Rootstock RPC Service provides a seamless and intuitive web interface for developers to interact with Rootstock nodes via JSON-RPC methods."
/>
<FilterItem
value="beginner, rpc"
title="Get Started with Alchemy"
subtitle="RPC API"
color="orange"
linkHref="/developers/rpc-api/alchemy/"
linkTitle="Use the RPC API"
description="A step-to-step guide for developers to interact with Rootstock network with the Alchemy RPC Provider Service."
/>
</Filter>
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: Using Remix and Rootstock Explorer
sidebar_label: Deploy, Interact and Verify Smart Contracts using Remix and Rootstock Explorer
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
sidebar_label: Account Abstraction using Etherspot Prime SDK
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
4 changes: 2 additions & 2 deletions docs/02-developers/04-quickstart/wagmi.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Using Wagmi and React Hooks
sidebar_label: Rootstock Wagmi Starter Kit
sidebar_position: 300
title: Rootstock Wagmi Starter dApp
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.'
tags: [rsk, rootstock, developers, wagmi, quickstart, dApps, Smart Contracts]
---
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: Using Web3.py
sidebar_label: Deploy and Interact with a Smart Contract using 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
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ To configure your `rskMainnet` and `rskTestnet` private keys, you'll need to upd
};
```

> See how to [Get an API Key from the RPC API](/developers/rpc-api/setup/)
> See how to [Get an API Key from the RPC API](/developers/rpc-api/rootstock/setup/)

> Replace `"your_mainnet_private_key"` and `"your_testnet_private_key"` with your private keys. For information on how to retrieve your private keys, see [How to export an account's private key](https://support.metamask.io/hc/en-us/articles/360015289632-How-to-export-an-account-s-private-key).
Expand Down
10 changes: 4 additions & 6 deletions docs/02-developers/07-rpc-api/02-rootstock/01-setup.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
---
sidebar_label: Getting Started
sidebar_label: Getting Started with the Rootstock RPC API
sidebar_position: 101
title: Getting Started with the Rootstock RPC Service
title: Getting Started with the Rootstock RPC API
tags: [faucet, Rootstock, testnet, address, wallet, tools]
description: "Get started with the Rootstock RPC Service to interact with Rootstock nodes."
---



## Getting Started

:::info[Note]
The [Rootstock RPC Service](https://rpc.rootstock.io/) is available on TESTNET and MAINNET.
The [Rootstock RPC API](https://rpc.rootstock.io/) is available on TESTNET and MAINNET.
:::

Visit the [Rootstock RPC Service](https://rpc.rootstock.io/)
Visit the [Rootstock RPC API](https://rpc.rootstock.io/)

<div align="center">
<img width="50%" src="/img/tools/rpc-api/01-rpc-api-landing.png" alt="RPC Service Landing Page"/>
Expand Down
4 changes: 2 additions & 2 deletions docs/02-developers/07-rpc-api/02-rootstock/02-methods.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
sidebar_label: Rootstock RPC Service Methods
sidebar_label: Rootstock RPC API Methods
sidebar_position: 102
title: Rootstock RPC Service Methods
title: Rootstock RPC API Methods
tags: [faucet, Rootstock, rpc api, testnet, address, wallet, tools]
description: "Easily create, interact and deploy EVM compatible smart contracts using a robust set of JSON RPC methods available through the RPC API."
---
Expand Down
6 changes: 3 additions & 3 deletions docs/02-developers/07-rpc-api/02-rootstock/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_label: Rootstock RPC Service
sidebar_label: Rootstock RPC API
sidebar_position: 100
title: Rootstock RPC Service
title: Rootstock RPC API
tags: [faucet, Rootstock, testnet, address, wallet, tools]
description: "Get started with the RPC API service to interact with Rootstock nodes."
---

The [Rootstock RPC Service](https://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/developers/rpc-api/rootstock/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain.
The [Rootstock RPC API](https://rpc.rootstock.io/) provides a seamless and intuitive web interface for developers to interact with [Rootstock nodes](/node-operators/setup/) via [JSON-RPC](/developers/rpc-api/rootstock/methods/) methods. It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain.

In this guide, you will learn:

Expand Down
9 changes: 5 additions & 4 deletions docs/02-developers/07-rpc-api/03-alchemy/index.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
sidebar_label: Alchemy RPC API
sidebar_label: Rootstock - Alchemy RPC Provider
sidebar_position: 300
title: Rootstock - Alchemy RPC Service
description: 'Short guide to interact with the Rootstock network by using Alchemy RPC service.'
title: Rootstock - Alchemy RPC Provider
description: 'Guide to interacting with the Rootstock network using Alchemy.'
tags: [rsk, rootstock, tutorials, developers, alchemy, quick starts, dApps, smart contracts, rpc]
---

This guide provides a step-to-step for developers to interact with Rootstock network with the [Alchemy RPC Provider Service](https://www.alchemy.com/).
A step-to-step guide for developers to interact with Rootstock network with the [Alchemy RPC Provider](https://www.alchemy.com/).

It aims to address the challenges faced by developers when trying to access critical information like logs, transactions, and balances through RPC, which can significantly impact the timely development of dApps on the Rootstock blockchain.

Expand All @@ -27,6 +27,7 @@ Before you start this guide, make sure you have the following:
- Developers looking to interact with the Rootstock nodes.

## Features

### Easy Setup
- Create an API key effortlessly to initiate development.
- Make your first API call in minutes.
Expand Down
7 changes: 7 additions & 0 deletions docs/02-developers/07-rpc-api/_category_.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@

label: RPC API Services available on Rootstock
position: 5
link:
type: generated-index
slug: /developers/rpc-api/
description: "RPC API services for interacting with Rootstock network."
14 changes: 0 additions & 14 deletions docs/02-developers/07-rpc-api/index.md

This file was deleted.

4 changes: 2 additions & 2 deletions docs/02-developers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Welcome to the Rootstock Developers Overview section.
This section enables developers getting started with the Rootstock blockchain. Developers can install a local development environment using Hardhat, etc, create and test contracts with the libraries provided and use the libraries to build decentralized applications

:::info[Info]
* Looking to quickly test your dApp on testnet before deploying to mainnet? Use the [RPC API](https://rpc.rootstock.io/) or view the [json-rpc methods](/developers/rpc-api/methods/) available on the RPC API.
* Looking to quickly test your dApp on testnet before deploying to mainnet? Use the [Rootstock RPC API](https://rpc.rootstock.io/) or view the [json-rpc methods](/developers/rpc-api/rootstock/methods/) available on the RPC API.
* Dive right in with [step-by-step guides](/developers/quickstart/) to get your development environment set up and deploy your first dApp.
:::

Expand All @@ -24,7 +24,7 @@ This section enables developers getting started with the Rootstock blockchain. D
| [Quick Starts](/developers/quickstart/) | Dive right in with step-by-step guides to get your development environment set up and deploy your first dApp.|
| [Smart Contract Development](/developers/smart-contracts/) | Explore in-depth resources on building secure and scalable smart contracts on Rootstock.|
| [Integration Guides](/developers/integrate/) | Deepen your knowledge with detailed guides and informative tutorials that cover various aspects of Rootstock development.|
| [JSON-RPC](/developers/rpc-api/setup/) | Test your dApps on testnet in minutes before deploying to mainnet using the RPC API.|
| [JSON-RPC](/developers/rpc-api/) | Test your dApps on testnet in minutes before deploying to mainnet using RPC API providers on Rootstock.|
| [Libraries](/developers/libraries/) | Access essential tools and libraries to streamline your development process. |


Loading

0 comments on commit f8d5482

Please sign in to comment.