[R4R] Basic docs (#537)

* add tools, client docs to pre/post bas scripts

* specify manual sidebar

* tools, building, resources

* remove legacy comment
This commit is contained in:
Denali Marsh 2020-06-01 18:49:13 -07:00 committed by GitHub
parent 5336ccc0c0
commit 47cdd7fb1a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 81 additions and 9 deletions

View File

@ -6,5 +6,52 @@ module.exports = {
src: "/kava-logo.svg",
},
custom: true,
},
autoSidebar: true,
sidebar: [
{
title: "Kava Tools",
children: [
{
title: "Chainlink Price Oracle",
path: "https://docs.kava.io/Tools/oracle.html"
},
{
title: "Auction Bot",
path: "https://docs.kava.io/Tools/auction.html",
static: true
}
]
},
{
title: "Resources",
children: [
{
title: "REST API Spec",
path: "https://rpc.kava.io/"
},
{
title: "Protocol Reference",
path: "https://godoc.org/github.com/Kava-Labs/kava"
}
]
},
{
title: "Community",
children: [
{
title: "Discord",
path: "https://discord.com/channels/704389840614981673/704389841051320362"
},
{
title: "Telegram",
path: "https://t.me/kavalabs"
},
{
title: "GitHub",
path: "https://github.com/Kava-Labs/kava"
}
]
}
]
}
};

View File

@ -1,7 +1,10 @@
#!/usr/bin/env bash
for D in ../x/*; do
if [ -d "${D}" ]; then
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
fi
done
# Modules
rm -rf Modules
# JavaScript SDK docs
rm -rf Building
# Kava Tools docs
rm -rf Tools

View File

@ -1,8 +1,30 @@
#!/usr/bin/env bash
mkdir -p Modules
for D in ../x/*; do
if [ -d "${D}" ]; then
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
mkdir -p "./$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_" && mv "./$_/README.md" "./$_/00_README.md"
rm -rf "Modules/$(echo $D | awk -F/ '{print $NF}')"
mkdir -p "Modules/$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_" && mv "./$_/README.md" "./$_/00_README.md"
fi
done
done
baseGitUrl="https://raw.githubusercontent.com/Kava-Labs"
# Client docs (JavaScript SDK)
clientGitRepo="javascript-sdk"
clientDir="Building"
mkdir -p "./${clientDir}"
curl "${baseGitUrl}/${clientGitRepo}/master/README.md" -o "./${clientDir}/${clientGitRepo}.md"
# Kava Tools docs
toolsGitRepo="kava-tools"
toolsDir="Tools"
toolDocs=("auction" "oracle")
mkdir -p "./${toolsDir}"
for T in ${toolDocs[@]}; do
curl "${baseGitUrl}/${toolsGitRepo}/master/${T}/README.md" -o "./${toolsDir}/${T}.md"
done