Merge PR #2054: docs: add config.js for ToC sidebar
This commit is contained in:
commit
55de750dbe
|
@ -8,10 +8,9 @@ and built using [VuePress](https://vuepress.vuejs.org/) from the Cosmos website
|
||||||
|
|
||||||
- https://github.com/cosmos/cosmos.network
|
- https://github.com/cosmos/cosmos.network
|
||||||
|
|
||||||
which has a [configuration file](https://github.com/cosmos/cosmos.network/blob/develop/docs/.vuepress/config.js) for displaying
|
Under the hood, Jenkins listens for changes (on develop or master) in ./docs then rebuilds
|
||||||
the Table of Contents that lists all the documentation.
|
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 cosmos.network 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
|
||||||
The `README.md` in this directory is the landing page for
|
|
||||||
website documentation.
|
website documentation.
|
||||||
|
|
|
@ -0,0 +1,86 @@
|
||||||
|
module.exports = {
|
||||||
|
title: "Cosmos Network",
|
||||||
|
description: "Documentation for the Cosmos Network.",
|
||||||
|
dest: "./site-docs",
|
||||||
|
base: "/",
|
||||||
|
markdown: {
|
||||||
|
lineNumbers: true
|
||||||
|
},
|
||||||
|
themeConfig: {
|
||||||
|
lastUpdated: "Last Updated",
|
||||||
|
nav: [{ text: "Back to Cosmos", link: "https://cosmos.network" }],
|
||||||
|
sidebar: [
|
||||||
|
{
|
||||||
|
title: "Introduction",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
"/introduction/cosmos-hub",
|
||||||
|
"/introduction/tendermint",
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "Getting Started",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
"/getting-started/voyager",
|
||||||
|
"/getting-started/installation",
|
||||||
|
"/getting-started/full-node",
|
||||||
|
"/getting-started/create-testnet"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "Cosmos SDK",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
["/sdk/overview", "Overview"],
|
||||||
|
["/sdk/core/intro", "Core"],
|
||||||
|
"/sdk/core/app1",
|
||||||
|
"/sdk/core/app2",
|
||||||
|
"/sdk/core/app3",
|
||||||
|
"/sdk/core/app4",
|
||||||
|
"/sdk/core/app5",
|
||||||
|
// "/sdk/modules",
|
||||||
|
"/sdk/clients"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
// {
|
||||||
|
// title: "Specifications",
|
||||||
|
// collapsable: false,
|
||||||
|
// children: [
|
||||||
|
// ["/specs/overview", "Overview"],
|
||||||
|
// "/specs/governance",
|
||||||
|
// "/specs/ibc",
|
||||||
|
// "/specs/staking",
|
||||||
|
// "/specs/icts",
|
||||||
|
// ]
|
||||||
|
// },
|
||||||
|
{
|
||||||
|
title: "Lotion JS",
|
||||||
|
collapsable: false,
|
||||||
|
children: [["/lotion/overview", "Overview"], "/lotion/building-an-app"]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "Validators",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
["/validators/overview", "Overview"],
|
||||||
|
["/validators/security", "Security"],
|
||||||
|
["/validators/validator-setup", "Validator Setup"],
|
||||||
|
"/validators/validator-faq"
|
||||||
|
]
|
||||||
|
},
|
||||||
|
{
|
||||||
|
title: "Resources",
|
||||||
|
collapsable: false,
|
||||||
|
children: [
|
||||||
|
// ["/resources/faq" "General"],
|
||||||
|
"/resources/delegator-faq",
|
||||||
|
["/resources/whitepaper", "Whitepaper - English"],
|
||||||
|
["/resources/whitepaper-ko", "Whitepaper - 한국어"],
|
||||||
|
["/resources/whitepaper-zh-CN", "Whitepaper - 中文"],
|
||||||
|
["/resources/whitepaper-pt", "Whitepaper - Português"]
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue