Browse Source

Zach/automated docs (#2225)

* add docs/config.js for better developer experience

* update docs_readme :)
pull/2234/head
Zach 6 years ago
committed by Ethan Buchman
parent
commit
e10666859f
2 changed files with 86 additions and 9 deletions
  1. +5
    -9
      docs/DOCS_README.md
  2. +81
    -0
      docs/config.js

+ 5
- 9
docs/DOCS_README.md View File

@ -8,14 +8,10 @@ and built using [VuePress](https://vuepress.vuejs.org/) from the tendermint webs
- https://github.com/tendermint/tendermint.com
which has a [configuration file](https://github.com/tendermint/tendermint.com/blob/develop/docs/.vuepress/config.js) for displaying
the Table of Contents that lists all the documentation.
Under the hood, Jenkins listens for changes (on develop or master) in ./docs then rebuilds
either the staging or production site depending on which branch the changes were made.
Under the hood, Jenkins listens for changes in ./docs then pushes a `docs-staging` branch to the tendermint.com repo with the latest documentation. That branch must be manually PR'd to `develop` then `master` for staging then production. This process should happen in synchrony with a release.
To update the Table of Contents (layout of the documentation sidebar), edit the
`config.js` in this directory, while the `README.md` is the landing page for the
website documentation.
The `README.md` in this directory is the landing page for
website documentation and the following folders are intentionally
ommitted:
- `architecture/` ==> contains Architecture Design Records
- `spec/` ==> contains the detailed specification

+ 81
- 0
docs/config.js View File

@ -0,0 +1,81 @@
module.exports = {
title: "Tendermint Core",
description: "Documentation for Tendermint Core",
dest: "./site-docs",
base: "/",
markdown: {
lineNumbers: true
},
themeConfig: {
lastUpdated: 'Last Updated',
nav: [
{ text: 'Back to Tendermint', link: 'https://tendermint.com' },
],
sidebar: [
{
title: "Getting Started",
collapsable: false,
children: [
"/introduction/quick-start",
"/introduction/install",
"/introduction/introduction",
]
},
{
title: "Tendermint Core",
collapsable: false,
children: [
"/tendermint-core/using-tendermint",
"/tendermint-core/configuration",
"/tendermint-core/rpc",
"/tendermint-core/running-in-production",
"/tendermint-core/how-to-read-logs",
"/tendermint-core/block-structure",
"/tendermint-core/light-client-protocol",
"/tendermint-core/metrics",
"/tendermint-core/secure-p2p",
"/tendermint-core/validators",
]
},
{
title: "Tendermint Tools",
collapsable: false,
children: [
"tools/benchmarking",
"tools/monitoring",
]
},
{
title: "Tendermint Networks",
collapsable: false,
children: [
"/networks/deploy-testnets",
"/networks/terraform-and-ansible",
"/networks/fast-sync",
]
},
{
title: "Application Development",
collapsable: false,
children: [
"/app-dev/getting-started",
"/app-dev/abci-cli",
"/app-dev/app-architecture",
"/app-dev/app-development",
"/app-dev/subscribing-to-events-via-websocket",
"/app-dev/indexing-transactions",
"/app-dev/abci-spec",
"/app-dev/ecosystem",
]
},
{
title: "Research",
collapsable: false,
children: [
"/research/determinism",
"/research/transactional-semantics",
]
},
]
}
}

Loading…
Cancel
Save