From 61b44016520430baac6559959afb811652805bd5 Mon Sep 17 00:00:00 2001 From: Jernej Kos Date: Wed, 5 Aug 2020 14:44:53 +0200 Subject: [PATCH] Add GitBook configuration --- .buildkite/pipeline.sh | 3 ++- .changelog/3174.trivial.md | 0 .gitbook.yaml | 5 ++++ docs/toc.md | 48 ++++++++++++++++++++++++++++++++++++++ 4 files changed, 55 insertions(+), 1 deletion(-) create mode 100644 .changelog/3174.trivial.md create mode 100644 .gitbook.yaml create mode 100644 docs/toc.md diff --git a/.buildkite/pipeline.sh b/.buildkite/pipeline.sh index 8ffe6db6464..777385caa53 100755 --- a/.buildkite/pipeline.sh +++ b/.buildkite/pipeline.sh @@ -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. diff --git a/.changelog/3174.trivial.md b/.changelog/3174.trivial.md new file mode 100644 index 00000000000..e69de29bb2d diff --git a/.gitbook.yaml b/.gitbook.yaml new file mode 100644 index 00000000000..75039af48f2 --- /dev/null +++ b/.gitbook.yaml @@ -0,0 +1,5 @@ +root: ./docs + +structure: + readme: index.md + summary: toc.md diff --git a/docs/toc.md b/docs/toc.md new file mode 100644 index 00000000000..45b9fdff8e5 --- /dev/null +++ b/docs/toc.md @@ -0,0 +1,48 @@ +# Table of Contents + + + +## 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)