Skip to content

Commit

Permalink
Add GitBook configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
kostko committed Aug 6, 2020
1 parent 285f81b commit 61b4401
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 1 deletion.
3 changes: 2 additions & 1 deletion .buildkite/pipeline.sh
Expand Up @@ -35,7 +35,8 @@ pr_and_no_code_related_changes() {
':(exclude).markdownlint.yml' \
':(exclude).punch_config.py' \
':(exclude)docs/' \
':(exclude)towncrier.toml'
':(exclude)towncrier.toml' \
':(exclude).gitbook.yaml'
}

# Helper that checks if anything under docker/ has been modified in a pull request.
Expand Down
Empty file added .changelog/3174.trivial.md
Empty file.
5 changes: 5 additions & 0 deletions .gitbook.yaml
@@ -0,0 +1,5 @@
root: ./docs

structure:
readme: index.md
summary: toc.md
48 changes: 48 additions & 0 deletions docs/toc.md
@@ -0,0 +1,48 @@
# Table of Contents

<!-- This is a table of contents used for GitBook. -->

## Development Setup

* Build Environment Setup and Building
* [Prerequisites](setup/prerequisites.md)
* [Building](setup/building.md)

* Running Tests and Development Networks
* [Running Tests](setup/running-tests.md)
* [Local Network Runner With a Simple Runtime](setup/oasis-net-runner.md)
* [Single Validator Node Network](setup/single-validator-node-network.md)

## High-Level Components

* [Consensus Layer](consensus/index.md)
* [Transactions](consensus/transactions.md)
* Services
* [Epoch Time](consensus/epochtime.md)
* [Random Beacon](consensus/beacon.md)
* [Staking](consensus/staking.md)
* [Registry](consensus/registry.md)
* [Committee Scheduler](consensus/scheduler.md)
* [Root Hash](consensus/roothash.md)
* [Key Manager](consensus/keymanager.md)
* [Runtime Layer](runtime/index.md)
* [Runtimes](runtime/index.md#runtimes)
* [Operation Model](runtime/index.md#operation-model)
* [Runtime Host Protocol](runtime/runtime-host-protocol.md)
* [Identifiers](runtime/identifiers.md)
* Oasis Node (`oasis-node`)
* [RPC](oasis-node/rpc.md)
* [Metrics](oasis-node/metrics.md)

## Common Functionality

* [Serialization](encoding.md)
* [Cryptography](crypto.md)
* Protocols
* [Authenticated gRPC](authenticated-grpc.md)
* [Merklized Key-Value Store (MKVS)](mkvs.md)

## Processes

* [Architectural Decision Records](adr/index.md)
* [Release Process](release-process.md)

0 comments on commit 61b4401

Please sign in to comment.