Skip to content

Commit

Permalink
Merge branch 'main' into dependabot/npm_and_yarn/docs/vuepress-vite-2…
Browse files Browse the repository at this point in the history
….0.0-beta.64
  • Loading branch information
ryanchristo authored Jul 5, 2023
2 parents 262e915 + 4b53e6f commit 7c2310d
Show file tree
Hide file tree
Showing 17 changed files with 440 additions and 298 deletions.
39 changes: 5 additions & 34 deletions docs/.vuepress/config.ts
Original file line number Diff line number Diff line change
Expand Up @@ -57,31 +57,24 @@ export default defineUserConfig({
'/ledger/': [
{
text: 'Introduction',
collapsable: false,
children: [
'/ledger/',
'/ledger/architecture',
'/ledger/interfaces',
],
},
{
text: 'Get Started',
collapsable: false,
children: [
'/ledger/get-started/',
'/ledger/get-started/manage-keys',
'/ledger/get-started/local-testnet',
'/ledger/get-started/live-networks',
],
},
{
text: 'Infrastructure',
collapsable: false,
children: [
'/ledger/infrastructure/',
'/ledger/infrastructure/interfaces',
'/ledger/get-started/regen-mainnet',
'/ledger/get-started/redwood-testnet',
],
},
{
text: 'Migration Guides',
collapsable: false,
children: [
'/ledger/migrations/',
'/ledger/migrations/v4.0-migration',
Expand All @@ -93,8 +86,6 @@ export default defineUserConfig({
'/modules/': [
{
text: 'Modules',
collapsable: false,
sidebarDepth: 0,
children: [
{
text: 'List of Modules',
Expand All @@ -104,8 +95,6 @@ export default defineUserConfig({
},
{
text: 'Data Module',
collapsable: true,
sidebarDepth: 0,
children: [
{
text: 'Overview',
Expand All @@ -123,8 +112,6 @@ export default defineUserConfig({
},
{
text: 'Ecocredit Module',
collapsable: true,
sidebarDepth: 0,
children: [
{
text: 'Overview',
Expand All @@ -142,8 +129,6 @@ export default defineUserConfig({
},
{
text: 'Intertx Module',
collapsable: true,
sidebarDepth: 0,
children: [
{
text: 'Overview',
Expand All @@ -157,7 +142,6 @@ export default defineUserConfig({
'/validators/': [
{
text: 'Validators',
collapsable: false,
children: [
{
text: 'Overview',
Expand All @@ -167,7 +151,6 @@ export default defineUserConfig({
},
{
text: 'Get Started',
collapsable: false,
children: [
'/validators/get-started/',
'/validators/get-started/install-regen',
Expand All @@ -180,7 +163,6 @@ export default defineUserConfig({
},
{
text: 'Upgrade Guides',
collapsable: false,
children: [
'/validators/upgrades/',
'/validators/upgrades/v2.0-upgrade',
Expand All @@ -195,7 +177,6 @@ export default defineUserConfig({
'/commands/': [
{
text: 'Commands',
collapsable: false,
children: [
{
text: 'List of Commands',
Expand All @@ -205,8 +186,6 @@ export default defineUserConfig({
},
{
text: 'Regen App',
collapsable: false,
sidebarDepth: 0,
children: [
{ text: 'regen', link: '/commands/regen' },
{ text: 'regen add-genesis-account', link: '/commands/regen_add-genesis-account' },
Expand Down Expand Up @@ -234,8 +213,6 @@ export default defineUserConfig({
'/tutorials/': [
{
text: 'Tutorials',
collapsable: false,
sidebarDepth: 0,
children: [
{
text: 'List of Tutorials',
Expand All @@ -245,7 +222,6 @@ export default defineUserConfig({
},
{
text: 'User Tutorials',
collapsable: false,
children: [
'/tutorials/user/ibc-transfers',
'/tutorials/user/currency-allowlist-proposal',
Expand All @@ -254,7 +230,6 @@ export default defineUserConfig({
},
{
text: 'Developer Tutorials',
collapsable: false,
children: [
'/tutorials/developer/tendermint-postgres-indexer',
],
Expand All @@ -263,8 +238,6 @@ export default defineUserConfig({
'/specs/': [
{
text: 'Specifications',
collapsable: false,
sidebarDepth: 0,
children: [
{
text: 'Overview',
Expand All @@ -275,7 +248,6 @@ export default defineUserConfig({
},
{
text: 'RFCs',
collapsable: false,
children: [
{
text: 'RFC Overview',
Expand All @@ -287,7 +259,6 @@ export default defineUserConfig({
},
{
text: 'ADRs',
collapsable: false,
children: [
{
text: 'ADR Overview',
Expand Down
5 changes: 3 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,9 @@ home: true
heroImage: /regen-ledger.png
heroText: Regen Ledger
tagline: Technical documentation for Regen Network's blockchain application and networks
actionText: Introduction →
actionLink: /ledger/
actions:
- text: Introduction →
link: /ledger/
features:
- title: Ecosystem Service Credits
details: Design and issue your own ecocredit. Agroforestry? Grasslands? Cover crops? You name it!
Expand Down
83 changes: 65 additions & 18 deletions docs/ledger/README.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,91 @@
# Regen Ledger
# Overview

Welcome! This page provides a high-level introduction to the Regen Ledger blockchain application and the networks governed and maintained by the Regen Network community.

## Regen Ledger

Regen Ledger is a public Proof-of-Stake (PoS) blockchain application built with [Cosmos SDK](https://docs.cosmos.network/). Regen Ledger provides the infrastructure for ecological assets and the verification of claims.

#### Learn More

Learn about the architecture, interfaces, and modules of Regen Ledger:

- [Architecture](architecture.md)
- [Interfaces](interfaces.md)
- [Modules](../modules/README.md)

#### Command-Line

Learn how to install the `regen` binary, manage keys, and start a local test network:

- [Install Regen](get-started)
- [Manage Keys](get-started/manage-keys.md)
- [Local Testnet](get-started/local-testnet.md)

## Regen Mainnet

[Regen Mainnet](https://www.regen.network/mainnet/) is the primary network supported by Regen Ledger. When referring to the Regen Network blockchain, we are referring to Regen Mainnet. Regen Mainnet is powered by the official [REGEN](https://www.regen.network/token/) token and there are currently 75 validators securing the network.
Regen Mainnet (otherwise referred to simply as "Regen") is the main blockchain network running the Regen Ledger application. Regen Mainnet is powered by the official [REGEN](https://www.regen.network/token/) token and currently has 75 validators securing the network.

#### Wallets

The following wallets currently support Regen Mainnet:

For more information, check out [Get Started: Live Networks](get-started/live-networks.md#regen-mainnet).
- [Keplr](https://wallet.keplr.app)
- [Cosmostation](https://wallet.cosmostation.io/regen)
- [Forbole](https://x.forbole.com/wallets)

### Block Explorers
#### Block Explorers

The following block explorers currently support Regen Mainnet:

- [Mintscan - Regen Mainnet](https://mintscan.io/regen)
- [Big Dipper - Regen Mainnet](https://regen.bigdipper.live)
- [Ping - Regen Mainnet](https://ping.pub/regen)
- [Mintscan](https://mintscan.io/regen)
- [Big Dipper](https://regen.bigdipper.live)
- [Ping](https://ping.pub/regen)

#### Command-Line

Learn how to interact with Regen Mainnet using the `regen` binary:

- [Regen Mainnet](get-started/regen-mainnet.md)

## Redwood Testnet

Redwood Testnet is a test network with the same configuration as Regen Mainnet. Developers can use Redwood Testnet to test out features in a stable testing environment. Unofficial REGEN tokens can be redeemed using a faucet.
Redwood Testnet (otherwise referred to as "Regen Redwood") is a stable test network with the same configuration as Regen Mainnet. Developers can use Redwood Testnet to test out features. Unofficial REGEN tokens can be redeemed using a token faucet.

For more information, check out [Get Started: Live Networks](get-started/live-networks.md#redwood-testnet).
#### Wallets

### Block Explorers
The following wallets currently support Redwood Testnet:

The following block explorers currently support Regen Redwood Testnet:
- [Keplr](https://wallet.keplr.app)

- [Aneka - Redwood Testnet](https://redwood.regen.aneka.io)
#### Block Explorers

## Wallets
The following block explorers currently support Redwood Testnet:

The following wallets currently support Regen Ledger:
- [Aneka](https://redwood.regen.aneka.io)

- [Keplr](https://wallet.keplr.app) (supports Mainnet and Redwood Testnet)
- [Cosmostation](https://wallet.cosmostation.io/regen)
- [Forbole](https://x.forbole.com/wallets)
#### Testnet Tokens

The following token faucets currently support Redwood Testnet:

- [Chora](https://chora.io/faucet)

#### Command-Line

Learn how to interact with Redwood Testnet using the `regen` binary:

- [Redwood Testnet](get-started/redwood-testnet.md)

## Community

Have any questions, comments, or new ideas? The following community channels are the best place to start for technical topics related to Regen Ledger:
Have any questions, comments, or new ideas? The following community channels are the best place to start for topics related to Regen Ledger, Regen Mainnet, and Redwood Testnet:

- [Regen Network Forum](https://forum.regen.network)
- [Regen Network Discord](https://discord.gg/regen-network)

## Contributing

Are you interested in contributing to the Regen Ledger codebase or documentation? Check out the contributing guidelines and feel free to open an issue or pull request:

- [Regen Ledger GitHub](https://github.com/regen-network/regen-ledger)
- [Regen Ledger Contributing](https://github.com/regen-network/regen-ledger/CONTRIBUTING.md)
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Core Functionality
# Architecture

## Built on Cosmos SDK
## Cosmos SDK

Regen Ledger is a proof-of-stake blockchain application built on top of [Cosmos SDK](https://github.com/cosmos/cosmos-sdk).

Much of the language and usage patterns when interacting with Regen Ledger follow directly from the usage patterns and architecture laid out in Cosmos SDK.

For more information about Cosmos SDK and what it means to build an "application specific blockchain", the [Cosmos SDK Documentation](https://docs.cosmos.network/main/intro/overview.html#what-are-application-specific-blockchains) is a great place to start.

## Regen Ledger Overview
## Regen Ledger

Regen Ledger is a single application binary that:
- Runs a fully functioning node in a public proof-of-stake network
Expand All @@ -17,14 +17,14 @@ Regen Ledger is a single application binary that:

Regen Ledger has two custom modules that support our desired functionality for ecosystem service credits and ecological data claims.

### Ecocredit Module
#### Ecocredit Module

The **Ecocredit Module** is our module for managing the issuance, trading, and retiring of credits pertaining to verifiable changes in ecosystem health.

Check out [Ecocredit Module Overview](../../modules/ecocredit/README.md) for more information about the ecocredit module.
Check out [Ecocredit Module Overview](../modules/ecocredit/README.md) for more information about the ecocredit module.

### Data Module
#### Data Module

The **Data Module** is used alongside the Ecocredit Module, enabling the anchoring of ecological data, attesting to the veracity of anchored data, and registering anchored data to a resolver.

Check out [Data Module Overview](../../modules/data/README.md) for more information about the data module.
Check out [Data Module Overview](../modules/data/README.md) for more information about the data module.
Loading

0 comments on commit 7c2310d

Please sign in to comment.