Skip to content

Commit 4f43809

Browse files
committed
Merge branch 'awa-docs-review' (#543)
* awa-docs-review: Update .gitignore minor edits, ensuring consistency of terms updated the front page of docs added the right favicon
2 parents 79890b5 + b3e8800 commit 4f43809

File tree

9 files changed

+48
-29
lines changed

9 files changed

+48
-29
lines changed

.gitignore

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,4 @@ target/
2626
wasm/*.wasm
2727

2828
# app version string file
29-
/apps/version.rs
29+
/apps/version.rs

documentation/docs/src/README.md

+25-3
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,34 @@ Welcome to Namada's docs!
44

55
## About Namada
66

7-
[Namada](https://namada.net/) is a sovereign proof-of-stake blockchain, using Tendermint BFT consensus, that enables multi-asset private transfers for any native or non-native asset using a multi-asset shielded pool derived from the Sapling circuit.
7+
[Namada](https://namada.net/) is a Proof-of-Stake layer 1 protocol for asset-agnostic, interchain privacy. Namada is Anoma's first fractal instance and is currently being developed by [Heliax](https://heliax.dev), a public goods lab.
88

9-
To learn more about the protocol, we recommend the following resources:
9+
Key innovations include:
10+
- ZCash-like transfers for any assets (fungible and non-fungible)
11+
- Rewarded usage of privacy as a public good
12+
- Interoperability with Ethereum via a custom bridge with trust-minimisation
13+
- Vertically integrated user interfaces
1014

11-
- [Introducing Namada: Shielded Transfers with Any Assets](https://medium.com/anomanetwork/introducing-namada-shielded-transfers-with-any-assets-dce2e579384c)
15+
To learn more, we recommend:
16+
- Article: [Introducing Namada: Shielded Transfers with Any Assets](https://medium.com/anomanetwork/introducing-namada-shielded-transfers-with-any-assets-dce2e579384c)
17+
18+
## Overview of features
19+
- Proof-of-Stake with governance to secure and evolve Namada
20+
- Fast-finality BFT with 4-second blocks
21+
- Near-zero fees
22+
- Trustless 2-way Ethereum bridge via IBC implementation on ETH
23+
- IBC bridges to chains that already speak IBC (all Cosmos chains)
24+
- MASP
25+
- Convert Circuit (shielded set rewards)
26+
- A reference interface
27+
- Ledger application
28+
29+
To learn more about the protocol, we recommend the following in-depth resources:
30+
- Talk at ZK8 [Namada: asset-agnostic interchain privacy](https://youtu.be/5K6YxmZPFkE)
1231
- [Namada's specifications](https://specs.namada.net)
32+
- [Codebase](https://github.com/anoma/namada)
33+
34+
## About this documentation
1335

1436
This book is written using [mdBook](https://rust-lang.github.io/mdBook/), the source can be found in the [Namada repository](https://github.com/anoma/namada/tree/main/documentation/docs).
1537

documentation/docs/src/SUMMARY.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
11
# Summary
22

33
- [Introduction](./README.md)
4-
- [Quick Start](./quick-start.md)
5-
- [User Guide](./user-guide/README.md)
6-
- [Install Namada](./user-guide/install.md)
4+
- [Quickstart](./quick-start.md)
5+
- [User guide](./user-guide/README.md)
6+
- [Installing Namada](./user-guide/install.md)
77
- [Getting started](./user-guide/getting-started.md)
8-
- [Manage a Wallet](./user-guide/wallet.md)
8+
- [Managing a wallet](./user-guide/wallet.md)
99
- [The Ledger](./user-guide/ledger.md)
10-
- [Interact with PoS](./user-guide/ledger/pos.md)
10+
- [Interacting with PoS](./user-guide/ledger/pos.md)
1111
- [Governance](./user-guide/ledger/governance.md)
12-
- [Private Transfers](./user-guide/ledger/masp.md)
12+
- [Shielded transfers](./user-guide/ledger/masp.md)
1313
- [Genesis validator setup](./user-guide/genesis-validator-setup.md)
1414
- [Applying to be a genesis validator](./user-guide/genesis-validator-apply.md)
1515
- [Testnets](./testnets/README.md)

documentation/docs/src/chapter_1.md

-1
This file was deleted.

documentation/docs/src/quick-start.md

+11-8
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,20 @@
1-
# Quick Start - How to run a validator node
1+
# Quickstart - How to run a validator on Namada?
22

33
## About this guide
44

5-
This guide is aimed at people interested in running a validator node and assumes basic knowledge of the terminal and how commands are used.
5+
This guide is for the ones interested in operating a Namada validator node and assumes basic knowledge of the terminal and how commands are used.
66

7-
* Comments start with `#`:
8-
`# this is a comment make sure you read them!`
9-
* Sample outputs start with an arrow:
10-
`➜ this is an example command line output useful for comparing`
7+
* Comments start with `#`:
118

12-
## Install Namada
9+
```# this is a comment make sure you read them!```
1310

14-
See [the install guide](user-guide/install.md) for details on installing the Namada binaries. Commands in this guide will assume you have the Namada binaries (`namada`, `namadan`, `namadaw`, `namadac`) on your path.
11+
* Sample outputs start with an arrow:
12+
13+
```➜ this is an example command line output useful for comparing```
14+
15+
## Installing Namada
16+
17+
See [the installation guide](user-guide/install.md) for details on installing the Namada binaries. Commands in this guide will assume you have the Namada binaries (`namada`, `namadan`, `namadaw`, `namadac`) on your path.
1518

1619
## Joining a network
1720

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
# User Guide
22

3-
Welcome to Namada user guide!
3+
Welcome to Namada's user guide!
44

5-
This guide is intended to help you find how to install, operate and interact with the Namada ledger node, the client and the wallet.
5+
This guide will help you find how to install, operate and interact with the Namada ledger node, the client, and the wallet.

documentation/docs/src/user-guide/ledger/masp.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Private transfers
1+
# Shielded transfers
22

3-
In Namada, private transfers are enabled by the Multi-Asset Shielded Pool (MASP). The MASP is a zero-knowledge circuit (zk-SNARK) that extends the Zcash Sapling circuit to add support for sending arbitrary assets. All assets in the pool share the same anonymity set, this means that the more transactions are issued to MASP, the stronger are the privacity guarantees.
3+
In Namada, shielded transfers are enabled by the Multi-Asset Shielded Pool (MASP). The MASP is a zero-knowledge circuit (zk-SNARK) that extends the Zcash Sapling circuit to add support for sending arbitrary assets. All assets in the pool share the same anonymity set, this means that the more transactions are issued to MASP, the stronger are the privacity guarantees.
44

55
## Using MASP
66

documentation/docs/theme/favicon.png

-4.7 KB
Loading

documentation/docs/theme/favicon.svg

+1-6
Loading

0 commit comments

Comments
 (0)