Browse Source

add docs/DOCS_README.md for devs, closes #1885 (#1905)

pull/1910/merge
Zach 6 years ago
committed by Anton Kaliaev
parent
commit
07747de305
2 changed files with 20 additions and 0 deletions
  1. +1
    -0
      .gitignore
  2. +19
    -0
      docs/DOCS_README.md

+ 1
- 0
.gitignore View File

@ -18,6 +18,7 @@ docs/tools
*.log
abci-cli
abci/types/types.pb.go
docs/node_modules/
scripts/wal2json/wal2json
scripts/cutWALUntil/cutWALUntil


+ 19
- 0
docs/DOCS_README.md View File

@ -0,0 +1,19 @@
# Documentation Maintenance Overview
The documentation found in this directory is hosted at:
- https://tendermint.com/docs/
and built using [VuePress](https://vuepress.vuejs.org/) from the tendermint website repo:
- 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.
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

Loading…
Cancel
Save