mirrors/tendermint
1
0
Fork 0
mirror of https://github.com/tendermint/tendermint.git synced 2026-06-01 11:56:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Docs theme (#4042)

Browse Source 
* docs theme

* vuepress-theme-cosmos

* version bump

* changes to docs

* more code changes

* sidebar order fix

* moar changes

* fixed dev sessions title

* fixed dev sessions title, again

* specs should show up in sidebar

* contents cards

* version bump

* sidebar, rpc

* version bump

* custom footer and super naive search

* version

* minor change to vuepress

* move swagger file

* pre and post scripts

* build

* changed docs build process

* added deployment config

* updated versions file and added deployment filters
This commit is contained in:
Denis Fadeev
2019-10-11 21:07:58 +05:00
committed by Marko
parent 3e5fa20f4c
commit aaa060fda4
69 changed files with 19291 additions and 640 deletions
Download Patch File Download Diff File Expand all files Collapse all files

26
docs/spec/README.md
View File

@@ -1,4 +1,12 @@
# Overview
---
order: 1
title: Overview
parent:
title: Tendermint Spec
order: 7
---
# Tendermint Spec
This is a markdown specification of the Tendermint blockchain.
It defines the base data structures, how they are validated,
@@ -27,18 +35,18 @@ please submit them to our [bug bounty](https://tendermint.com/security)!
### P2P and Network Protocols
- [The Base P2P Layer](./p2p/): multiplex the protocols ("reactors") on authenticated and encrypted TCP connections
- [Peer Exchange (PEX)](./reactors/pex/): gossip known peer addresses so peers can find each other
- [Block Sync](./reactors/block_sync/): gossip blocks so peers can catch up quickly
- [Consensus](./reactors/consensus/): gossip votes and block parts so new blocks can be committed
- [Mempool](./reactors/mempool/): gossip transactions so they get included in blocks
- [Evidence](./reactors/evidence/): sending invalid evidence will stop the peer
- [The Base P2P Layer](./p2p/node.md): multiplex the protocols ("reactors") on authenticated and encrypted TCP connections
- [Peer Exchange (PEX)](./reactors/pex/reactor.md): gossip known peer addresses so peers can find each other
- [Block Sync](./reactors/block_sync/reactor.md): gossip blocks so peers can catch up quickly
- [Consensus](./reactors/consensus/consensus.md): gossip votes and block parts so new blocks can be committed
- [Mempool](./reactors/mempool/reactor.md): gossip transactions so they get included in blocks
- [Evidence](./reactors/evidence/reactor.md): sending invalid evidence will stop the peer
### Software
- [ABCI](./software/abci.md): Details about interactions between the
- [ABCI](./abci/README.md): Details about interactions between the
application and consensus engine over ABCI
- [Write-Ahead Log](./software/wal.md): Details about how the consensus
- [Write-Ahead Log](./consensus/wal.md): Details about how the consensus
engine preserves data and recovers from crash failures
## Overview

6
docs/spec/abci/README.md
View File

@@ -1,4 +1,8 @@
# Overview
---
cards: true
---
# ABCI
ABCI is the interface between Tendermint (a state-machine replication engine)
and your application (the actual state machine). It consists of a set of

5
docs/spec/blockchain/readme.md Normal file
View File

@@ -0,0 +1,5 @@
---
cards: true
---
# Blockchain

2
docs/spec/consensus/abci.md
View File

@@ -1 +1,3 @@
# ABCI
[Moved](../software/abci.md)

5
docs/spec/consensus/readme.md Normal file
View File

@@ -0,0 +1,5 @@
---
cards: true
---
# Consensus

5
docs/spec/p2p/readme.md Normal file
View File

@@ -0,0 +1,5 @@
---
cards: true
---
# P2P

5
docs/spec/reactors/readme.md Normal file
View File

@@ -0,0 +1,5 @@
---
cards: true
---
# Reactors

25
docs/spec/rpc/index.html
View File

@@ -1,25 +0,0 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Tendermint RPC</title>
<link rel="stylesheet" type="text/css" href="//unpkg.com/swagger-ui-dist@3/swagger-ui.css" >
<link rel="icon" type="image/png" href="//unpkg.com/swagger-ui-dist@3/favicon-16x16.png"/>
<script src="//unpkg.com/swagger-ui-dist@3/swagger-ui-bundle.js"></script>
</head>
<body>
<div id="swagger-ui"></div>
<script>
window.onload = function() {
window.ui = SwaggerUIBundle({
url: "./swagger.yaml",
dom_id: '#swagger-ui',
deepLinking: true,
layout: "BaseLayout"
});
}
</script>
</body>
</html>

2677
docs/spec/rpc/swagger.yaml
View File

File diff suppressed because it is too large Load Diff