added documentation setup instructions
This commit is contained in:
parent
c931c1fc99
commit
a77965550d
3 changed files with 34 additions and 0 deletions
1
docs/5-docs/1-overview.md
Normal file
1
docs/5-docs/1-overview.md
Normal file
|
@ -0,0 +1 @@
|
||||||
|
# Overview
|
29
docs/5-docs/2-setting-up.md
Normal file
29
docs/5-docs/2-setting-up.md
Normal file
|
@ -0,0 +1,29 @@
|
||||||
|
# Setting Up
|
||||||
|
|
||||||
|
## Steps
|
||||||
|
|
||||||
|
### Local
|
||||||
|
|
||||||
|
1. Install node.js and yarn.
|
||||||
|
|
||||||
|
2. Clone the [documentation repository](https://github.com/llama-bot/llama-bot-docs).
|
||||||
|
|
||||||
|
```bash
|
||||||
|
git clone https://github.com/llama-bot/llama-bot-docs
|
||||||
|
```
|
||||||
|
|
||||||
|
3. Install dependencies.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn install
|
||||||
|
```
|
||||||
|
|
||||||
|
4. Test locally. Live edit is supported.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
yarn start
|
||||||
|
```
|
||||||
|
|
||||||
|
### Deployment
|
||||||
|
|
||||||
|
1. Follow the [instructions from docusaurus](https://docusaurus.io/docs/deployment#deploying-to-github-pages)
|
4
docs/5-docs/_category_.json
Normal file
4
docs/5-docs/_category_.json
Normal file
|
@ -0,0 +1,4 @@
|
||||||
|
{
|
||||||
|
"label": "Docs",
|
||||||
|
"position": 5
|
||||||
|
}
|
Loading…
Add table
Add a link
Reference in a new issue