smeb_y/0g-chain
1
0
Fork 0
mirror of https://github.com/0glabs/0g-chain.git synced 2024-12-24 23:35:19 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update docs for mainnet (#579)

Browse Source 
* kava-3 migration guide

* update readme for mainnet

* fix broken link

* build against new cache

* remove link, deploy, then reinstate it

* add it back in...

* revert to original

* add ipfs to link-check ignore regex
This commit is contained in:
Denali Marsh 2020-06-15 04:11:29 -07:00 committed by GitHub
parent 3784b4971b
commit 037700388b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 26 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Makefile
View File

@ -101,7 +101,7 @@ clean:
# This tool checks local markdown links as well. # This tool checks local markdown links as well.
# Set to exclude riot links as they trigger false positives # Set to exclude riot links as they trigger false positives
link-check: link-check:
@go run github.com/raviqqe/liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*" @go run github.com/raviqqe/liche -r . --exclude "^http://127.*|^https://riot.im/app*|^http://kava-testnet*|^https://testnet-dex*|^https://kava3.data.kava.io*|^https://ipfs.io*"
lint: lint:

10
README.md
View File

@ -34,7 +34,7 @@ git checkout v0.8.1
make install make install
``` ```
## Mainnet Upgrade ### Upgrade
The scheduled mainnet upgrade to `kava-3` took place on June 10th, 2020 at 14:00 UTC. The version of Kava for `kava-3` is [__v0.8.1__](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1). The scheduled mainnet upgrade to `kava-3` took place on June 10th, 2020 at 14:00 UTC. The version of Kava for `kava-3` is [__v0.8.1__](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1).
@ -51,7 +51,13 @@ jq -S -c -M '' genesis.json | shasum -a 256
## Testnet ## Testnet
For further information on joining the lastest testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). The recommended version of the software for kava-testnet-6000 is v0.8.0-rc1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets).
## Docs
Kava protocol and client documentation can be found in the [Kava docs](https://docs.kava.io).
If you have technical questions or concerns, ask a developer or community member in the [Kava discord](https://discord.com/invite/kQzh3Uv).
## License ## License

4
docs/.vuepress/config.js
View File

@ -27,6 +27,10 @@ module.exports = {
{ {
title: "JavaScript SDK", title: "JavaScript SDK",
path: "/building/javascript-sdk.html" path: "/building/javascript-sdk.html"
},
{
title: "Migration Guide: kava-3",
path: "/building/kava-3-migration-guide.html"
} }
] ]
}, },

4
docs/pre.sh
View File

@ -1,5 +1,6 @@
#!/usr/bin/env bash #!/usr/bin/env bash
# Clone each module's markdown files
mkdir -p Modules mkdir -p Modules
for D in ../x/*; do for D in ../x/*; do
@ -22,6 +23,9 @@ parent:
order: false order: false
---" > "./${clientDir}/readme.md" ---" > "./${clientDir}/readme.md"
# Copy the kava-3-migration guide
cp ../contrib/kava-3/migration.md "./${clientDir}/kava-3-migration-guide.md"
# Kava Tools docs # Kava Tools docs
toolsGitRepo="kava-tools" toolsGitRepo="kava-tools"
toolsDir="tools" toolsDir="tools"

12
docs/readme.md
View File

@ -6,18 +6,24 @@ Reference implementation of Kava, a blockchain for cross-chain DeFi. Built using
## Mainnet ## Mainnet
Note, the current recommended version of the software for mainnet is v0.3.2. The master branch of this repository contains considerable development work since the last mainnet release and is **not** runnable on mainnet. The current recommended version of the software for mainnet is [v0.8.1](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1). Note, the master branch of this repository contains development work since the last mainnet release and it may **not** be runnable on mainnet.
### Installation ### Installation
```sh ```sh
git checkout v0.3.2 git checkout v0.8.1
make install make install
``` ```
### Upgrade
The mainnet upgrade to `kava-3` took place on June 10th, 2020 at 14:00 UTC. The version of Kava for `kava-3` is [__v0.8.1__](https://github.com/Kava-Labs/kava/releases/tag/v0.8.1).
Migration instructions can be found [here](https://docs.kava.io/building/kava-3-migration-guide.html).
## Testnet ## Testnet
The recommended version of the software for kava-testnet-4000 is v0.4.1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets). The recommended version of the software for kava-testnet-6000 is v0.8.0-rc1. For further information on joining the testnet, head over to the [testnet repo](https://github.com/Kava-Labs/kava-testnets).
## License ## License