Skip to content

Commit 525dcd1

Browse files
dneorejgitbook-bot
authored andcommitted
GitBook: [#20] New Docs Structure
1 parent dcd9a3b commit 525dcd1

File tree

82 files changed

+1663
-578
lines changed

Some content is hidden

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

82 files changed

+1663
-578
lines changed
114 KB
Loading

.gitbook/assets/XPRT Role (1).png

294 KB
Loading

.gitbook/assets/XPRT Role.png

294 KB
Loading

.gitbook/assets/image.png

345 KB
Loading

.gitbook/assets/xprt.png

1.96 KB
Loading

Chain/creating-a-wallet.md

Whitespace-only changes.

Chain/governance.md

Lines changed: 0 additions & 7 deletions
This file was deleted.

Contracts/interacting-with-contracts.md

Lines changed: 0 additions & 1 deletion
This file was deleted.

Intro/what-is-cosmos.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

Intro/what-is-pstake.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

Intro/why-persistence.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

README (1).md

Lines changed: 0 additions & 22 deletions
This file was deleted.

README.md

Lines changed: 38 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,42 @@
1-
# What is Proof of Stake
1+
---
2+
description: Understand, Explore and Build the Persistence Liquid Staking Hub
3+
layout: landing
4+
---
25

3-
In PoS, the network is secured not by the resource-intensive work of hundreds of miners, but rather by **validators** locking, or ‘staking’ large quantities of the network’s native cryptocurrency. This allows validators to participate in the validation process of new blocks, as well as entitling them to receive smaller amounts of the currency in periodic rewards.
6+
# 👓 Overview
47

5-
The core idea here is that if someone locks up significant funds within the network, then, by extension, they care about the overall health and validity of the network, i.e. their interests are aligned with the collective. An insecure network’s token will lose value, and consequently, the validator’s stake will also lose value. To add to this, validators are also kept in check by a penalty for illegal or malicious behaviour, which takes away a portion of their [staked tokens](https://academy.stakedao.org/what-is-staking/).
8+
Welcome to Persistence Docs! Here you can find anything and everything related to the Persistence Liquid Staking Hub. We invite you to Learn, Participate, Explore, Build, Integrate, Validate and Connect with us on this journey. 
69

7-
PoS is designed to be a lot more energy efficient than [PoW](https://academy.stakedao.org/what-is-proof-of-work/), and also broadens the opportunity for the public to participate in mining for the network. Users without the necessary funds to become a validator themselves are able to delegate their tokens to a validator in exchange for a proportion of the rewards earned for securing the network.
8-
9-
{% hint style="info" %}
10-
**Good to know:** Splitting your product into fundamental concepts, objects, or areas can be a great way to let readers deep dive into the concepts that matter most to them.
10+
{% hint style="warning" %}
11+
<mark style="color:red;">Note: This new Persistence Docs is still in a draft stage. We apologise if the information you're looking for is not yet available. Feel free to contribute to make it better, or please reach out to the team directly with any questions you might have.</mark>&#x20;
1112
{% endhint %}
13+
14+
## Learn 📖
15+
16+
The perfect place to build context in case you're just getting started
17+
18+
<table data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td align="center"><strong>Introduction</strong></td><td>About Persistence, the why, the problem statement and the offered solutions</td><td><a href="learn/introduction.md">introduction.md</a></td><td></td></tr><tr><td align="center"><strong>Ecosystem Overview</strong></td><td>Explore the various parts of the Liquid Staking Hub</td><td><a href="learn/ecosystem-overview.md">ecosystem-overview.md</a></td><td></td></tr><tr><td align="center"><strong>Foundation</strong></td><td>To foster a flourishing Liquid Staking Ecosystem by driving utility to $XPRT</td><td><a href="learn/persistence-foundation.md">persistence-foundation.md</a></td><td></td></tr><tr><td align="center"><strong>Labs</strong></td><td>Driving product innovation, applications and tools for the Persistence Network. </td><td><a href="learn/persistence-labs.md">persistence-labs.md</a></td><td></td></tr><tr><td align="center"><strong>Fundamentals</strong></td><td>Some basic concepts to get you started</td><td><a href="learn/fundamentals/">fundamentals</a></td><td></td></tr></tbody></table>
19+
20+
## Participate & Explore 🔍
21+
22+
Your participation matters! Read all about how you can participate in the Persistence ecosystem, and explore all the tools available to help you do so. &#x20;
23+
24+
<table data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>$XPRT</strong></td><td>Find out how to acquire and stake the native ecosystem token and use it in Governance and DeFi.</td><td><a href="participate/xprt/stake.md">stake.md</a></td></tr><tr><td align="center"><strong>Discuss</strong></td><td>Engage in discussions, come up with new ideas, challenge the status quo</td><td><a href="broken-reference">Broken link</a></td></tr><tr><td align="center"><strong>Wallets</strong></td><td>Find out which wallets to use to interact with the Persistence chain</td><td><a href="participate/wallets.md">wallets.md</a></td></tr><tr><td align="center"><strong>Explorers</strong></td><td>Your options to find the on-chain data you need</td><td><a href="participate/explorers.md">explorers.md</a></td></tr><tr><td align="center"><strong>Analytics</strong></td><td>Some interesting analytics dashboards</td><td><a href="participate/analytics.md">analytics.md</a></td></tr><tr><td align="center"><strong>Bridges</strong></td><td>Your options for bridging assets into or out of Persistence</td><td><a href="participate/bridges.md">bridges.md</a></td></tr></tbody></table>
25+
26+
## Build, Integrate, Validate ⚒️
27+
28+
Technical Documentation for builders & validators
29+
30+
<table data-view="cards"><thead><tr><th align="center"></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td align="center"><strong>Nodes &#x26; Endpoints</strong></td><td>Public Nodes &#x26; Endpoints, and how to run a node on testnet or mainnet</td><td><a href="build/nodes-and-endpoints/">nodes-and-endpoints</a></td></tr><tr><td align="center"><strong>Validators</strong></td><td>How to become a validator on testnet or mainnet</td><td><a href="build/validators/">validators</a></td></tr><tr><td align="center"><strong>Relayers</strong></td><td>Which relayers are maintained, and how to run one yourself</td><td><a href="build/relayers/">relayers</a></td></tr><tr><td align="center"><strong>Indexers</strong></td><td>How to connect to and even run Graph Nodes</td><td><a href="build/indexers/">indexers</a></td></tr><tr><td align="center"><strong>Smart Contracts</strong></td><td>How to build Dapps on top of the Persistence Chain via CosmWasm</td><td><a href="build/smart-contracts/">smart-contracts</a></td></tr><tr><td align="center"><strong>Modules</strong></td><td>Understand the current modules and how to leverage them</td><td><a href="build/tools/">tools</a></td></tr><tr><td align="center"><strong>Tools</strong></td><td>Find all tools that have been built for the ecosystem</td><td><a href="build/modules/">modules</a></td></tr><tr><td align="center"><strong>Contribute</strong></td><td>How to contribute to the persistence ecosystem</td><td><a href="build/contribute.md">contribute.md</a></td></tr><tr><td align="center"><strong>Grants</strong></td><td>How to get support &#x26; funding from the Foundation</td><td><a href="broken-reference">Broken link</a></td></tr></tbody></table>
31+
32+
## Connect & Follow 😍
33+
34+
Find all links to the Persistence official pages and channels [on this page](connect-and-follow.md)
35+
36+
37+
38+
39+
40+
41+
42+
**Disclaimer:** _While this docs page is provided and maintained as a collaborative effort between Persistence Labs & the Persistence Foundation, there is no guarantee that all presented information is up-to-date at all times. We invite the community to flag any errors or inaccuracies and contribute to keeping the docs up-to-date._&#x20;

SUMMARY.md

Lines changed: 69 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -1,60 +1,71 @@
11
# Table of contents
22

3-
## Intro
4-
5-
* [What is Proof of Stake](README.md)
6-
* [What is Cosmos](Intro/what-is-cosmos.md)
7-
* [What is Liquid Staking](Intro/what-is-liquid-staking.md)
8-
* [What is DeFi](Intro/what-is-defi.md)
9-
* [What is Persistence One?](<README (1).md>)
10-
* [Why Persistence?](Intro/why-persistence.md)
11-
* [What is pSTAKE?](Intro/what-is-pstake.md)
12-
13-
## pSTAKE
14-
15-
* [Staked Cosmos Assets](pstake/cosmos-assets.md)
16-
17-
## Chain
18-
19-
* [Creating a Wallet](Chain/creating-a-wallet.md)
20-
* [Governance](Chain/governance.md)
21-
* [Setup](Chain/setup.md)
22-
* [Mainnet Validator](Chain/mainnet-validator-setup.md)
23-
* [Testnet Validator](Chain/testnet-validator-setup.md)
24-
25-
26-
27-
## Contracts
28-
29-
* [Overview](Contracts/overview.md)
30-
* [Uploading a Contract](Contracts/uploading-a-contract.md)
31-
* [Interacting with a Contract](Contracts/interacting-with-contracts.md)
32-
33-
## 📘 Guides
34-
35-
* [Stake $XPRT](guides/stake-usdxprt.md)
36-
* [Provide Liquidity](guides/provide-liquidity.md)
37-
38-
## 💻 Technology
39-
40-
* [Grants](technology/grants.md)
41-
* [Validators](technology/validators.md)
42-
* [Audits](technology/audits.md)
43-
* [Persistence SDK](technology/persistence-sdk.md)
44-
45-
## 🪙 Tokens
46-
47-
* [$XPRT](tokens/usdxprt.md)
48-
* [$PSTAKE](tokens/usdpstake.md)
49-
* [$XPRT-$PSTAKE Relationship](tokens/usdxprt-usdpstake-relationship.md)
50-
51-
## Links
52-
53-
* [Website](https://persistence.one)
54-
* [Github](https://github.com/persistenceOne)
55-
* [Blog](https://medium.com/persistence-blog)
56-
57-
## Ecosystem
58-
59-
* [Bamboo](ecosystem/Dexter.md)
60-
* [Dexter](ecosystem/dexter.md)
3+
* [👓 Overview](README.md)
4+
5+
## 📖 Learn
6+
7+
* [Introduction](learn/introduction.md)
8+
* [Ecosystem Overview](learn/ecosystem-overview.md)
9+
* [Persistence Foundation](learn/persistence-foundation.md)
10+
* [Persistence Labs](learn/persistence-labs.md)
11+
* [Fundamentals](learn/fundamentals/README.md)
12+
* [What is Proof-of-Stake](learn/fundamentals/what-is-proof-of-stake.md)
13+
* [What is Cosmos](learn/fundamentals/what-is-cosmos.md)
14+
* [What is DeFi](learn/fundamentals/what-is-defi.md)
15+
* [What is Liquid Staking](learn/fundamentals/what-is-liquid-staking.md)
16+
17+
## 🔍 Participate & Explore <a href="#participate" id="participate"></a>
18+
19+
* [$XPRT Token](participate/xprt/README.md)
20+
* [Acquire](participate/xprt/acquire.md)
21+
* [Stake](participate/xprt/stake.md)
22+
* [Governance](participate/xprt/governance.md)
23+
* [DeFi](participate/xprt/defi/README.md)
24+
* [Provide Liquidity](participate/xprt/defi/provide-liquidity.md)
25+
* [Liquid Stake](participate/xprt/defi/liquid-stake.md)
26+
* [Borrow / Lend](participate/xprt/defi/borrow-lend.md)
27+
* [Wallets](participate/wallets.md)
28+
* [Explorers](participate/explorers.md)
29+
* [Analytics](participate/analytics.md)
30+
* [Bridges](participate/bridges.md)
31+
32+
## ⚒ Build, Integrate, Validate <a href="#build" id="build"></a>
33+
34+
* [Nodes & Endpoints](build/nodes-and-endpoints/README.md)
35+
* [Public Infrastructure](build/nodes-and-endpoints/public-infrastructure.md)
36+
* [Setup a node](build/nodes-and-endpoints/setup.md)
37+
* [Set up a local testnet](build/nodes-and-endpoints/set-up-a-local-testnet.md)
38+
* [Join Testnet](build/nodes-and-endpoints/join-testnet.md)
39+
* [Join Mainnet](build/nodes-and-endpoints/join-mainnet.md)
40+
* [Validators](build/validators/README.md)
41+
* [Validate on Mainnet](build/validators/mainnet-validator-setup.md)
42+
* [Validate on Testnet](build/validators/testnet-validator-setup.md)
43+
* [Validator Communication](build/validators/validator-communication.md)
44+
* [Foundation Delegations](build/validators/foundation-delegations/README.md)
45+
* [Round 1](build/validators/foundation-delegations/round-1.md)
46+
* [Relayers](build/relayers/README.md)
47+
* [IBC Channels](build/relayers/ibc-channels.md)
48+
* [IBC Relayers](build/relayers/ibc-relayers.md)
49+
* [Relay on Mainnet](build/relayers/relay-on-mainnet.md)
50+
* [Relay on Testnet](build/relayers/relay-on-testnet.md)
51+
* [Indexers](build/indexers/README.md)
52+
* [Connect to a Subgraph](build/indexers/connect-to-a-subgraph.md)
53+
* [Run a Subgraph](build/indexers/run-a-subgraph.md)
54+
* [Run a Graph Firehose](build/indexers/run-a-graph-firehose.md)
55+
* [Smart Contracts](build/smart-contracts/README.md)
56+
* [Overview](build/smart-contracts/overview.md)
57+
* [Uploading a Contract](build/smart-contracts/uploading-a-contract.md)
58+
* [CosmWasm](build/smart-contracts/cosmwasm.md)
59+
* [Modules](build/modules/README.md)
60+
* [pSTAKE module](build/modules/pstake-module.md)
61+
* [Epochs module](build/modules/epochs-module.md)
62+
* [Tools](build/tools/README.md)
63+
* [Persistence JS](build/tools/persistence-js.md)
64+
* [Persistence SDK](build/tools/persistence-sdk.md)
65+
* [Persistence CLI](build/tools/persistence-cli.md)
66+
* [Contribute](build/contribute.md)
67+
* [Grants](build/grants.md)
68+
69+
***
70+
71+
* [😍 Connect & Follow](connect-and-follow.md)

build/contribute.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
description: All contributions to the documentation & tooling are greatly appreciated
3+
---
4+
5+
# Contribute
6+
7+
<mark style="color:red;">Section to be reviewed and updated</mark>

0 commit comments

Comments
 (0)