From 62db357942f317acb6a9b97f645e908a7801f4b4 Mon Sep 17 00:00:00 2001 From: Ian Hobson Date: Mon, 16 Dec 2024 12:19:30 +0100 Subject: [PATCH] Move the license to the top level and add a contributing guide --- CONTRIBUTING.md | 14 ++++++++++++++ website/LICENSE => LICENSE | 0 2 files changed, 14 insertions(+) create mode 100644 CONTRIBUTING.md rename website/LICENSE => LICENSE (100%) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..42d8ddf --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,14 @@ +# Contributing to the Koto website + +Thank you for your interesting in contributing to the Koto website! + +## Improving documentation + +The source material for the website docs is maintained in the [Koto repository](https://github.com/koto-lang/koto/tree/main/crates/cli/docs), which is included here as a [submodule](./modules/koto). Versioned snapshots are maintained in [this repository](./website/content/docs/). + +It can be helpful to work on documentation improvements while seeing how they look on the website, and the following workflow is suggested: + +- Create a branch in the [Koto submodule](./modules/koto). +- Changes to the docs should be made in the [docs folder](./modules/koto/crates/cli/docs/). +- In the [website folder], run `just docs-watch` to automatically build the docs when files are changed. +- In another shell, run `just serve` to open the site in a browser. The site will be automatically refreshed when the docs are updated. diff --git a/website/LICENSE b/LICENSE similarity index 100% rename from website/LICENSE rename to LICENSE