From a4743e8da01760dbf5182ae2cdaa40899c3d6d3f Mon Sep 17 00:00:00 2001 From: ojack Date: Tue, 21 Nov 2023 12:25:38 +0100 Subject: [PATCH] updated documentation --- README.md | 13 +++++++++---- content/_index.md | 2 +- content/docs/reference.md | 3 +-- 3 files changed, 11 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 5e5bc7e..a140163 100644 --- a/README.md +++ b/README.md @@ -4,16 +4,21 @@ source code for documentation running at https://hydra-synth.github.io/hydra-doc ### To run locally: -1. install hugo: +1. install hugo: https://gohugo.io/installation/ 2. clone this repo: ```git clone https://github.com/hydra-synth/hydra-docs-v2.git``` 3. clone submodules: ```git submodule update --init --recursive``` 4. run locally: ```hugo serve``` -5. (optional) set baseURL in `config.toml` or using `--baseURL` to your hosting URL (e.g., `https://myhydrawebsite.com/blog`) -6. (optional) build: -```hugo``` + +### To edit: +1. Create a branch of this repo +2. Update markdown files contained in the `/content/docs`` folder +3. Commit your changes +4. Submit a pull request + + ### Content that is not yet included - Information about alternative editors such as flok, atom/pulsar. diff --git a/content/_index.md b/content/_index.md index 20014b6..c3bfbea 100644 --- a/content/_index.md +++ b/content/_index.md @@ -3,7 +3,7 @@ title: "hydra video synth: documentation portal" draft: false weight: 1 images: [ images/hydra.png ] -description: "how to use hydra" +description: "tutorials and reference for using hydra" --- # What is Hydra? diff --git a/content/docs/reference.md b/content/docs/reference.md index 0912ca1..0aea3b1 100644 --- a/content/docs/reference.md +++ b/content/docs/reference.md @@ -2,8 +2,7 @@ weight: 3 bookFlatSection: true title: "reference" -bookCollapseSection: true - +# bookCollapseSection: true --- \ No newline at end of file