mirror of
https://github.com/0glabs/0g-chain.git
synced 2024-12-24 23:35:19 +00:00
[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:
parent
5336ccc0c0
commit
47cdd7fb1a
@ -6,5 +6,52 @@ module.exports = {
|
|||||||
src: "/kava-logo.svg",
|
src: "/kava-logo.svg",
|
||||||
},
|
},
|
||||||
custom: true,
|
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"
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
|
]
|
||||||
|
}
|
||||||
};
|
};
|
||||||
|
13
docs/post.sh
13
docs/post.sh
@ -1,7 +1,10 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
for D in ../x/*; do
|
# Modules
|
||||||
if [ -d "${D}" ]; then
|
rm -rf Modules
|
||||||
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
|
|
||||||
fi
|
# JavaScript SDK docs
|
||||||
done
|
rm -rf Building
|
||||||
|
|
||||||
|
# Kava Tools docs
|
||||||
|
rm -rf Tools
|
||||||
|
28
docs/pre.sh
28
docs/pre.sh
@ -1,8 +1,30 @@
|
|||||||
#!/usr/bin/env bash
|
#!/usr/bin/env bash
|
||||||
|
|
||||||
|
mkdir -p Modules
|
||||||
|
|
||||||
for D in ../x/*; do
|
for D in ../x/*; do
|
||||||
if [ -d "${D}" ]; then
|
if [ -d "${D}" ]; then
|
||||||
rm -rf "./$(echo $D | awk -F/ '{print $NF}')"
|
rm -rf "Modules/$(echo $D | awk -F/ '{print $NF}')"
|
||||||
mkdir -p "./$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_" && mv "./$_/README.md" "./$_/00_README.md"
|
mkdir -p "Modules/$(echo $D | awk -F/ '{print $NF}')" && cp -r $D/spec/* "$_" && mv "./$_/README.md" "./$_/00_README.md"
|
||||||
fi
|
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
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user