docs: instructions on how to develop the docs website

2026-02-14 09:59:57 +00:00 · 2021-11-03 15:07:45 +01:00
parent e83f344cdc
commit 3d31ddb4e3
1 changed files with 12 additions and 0 deletions
--- a/docs/README.md
+++ b/docs/README.md
@@ -0,0 +1,12 @@
+# Capsule Documentation
+
+1. Ensure to have [`yarn`](https://classic.yarnpkg.com/lang/en/docs/install/#debian-stable) installed in your path.
+2. `yarn install`
+
+## Local development
+
+```shell
+yarn develop
+```
+
+This will create a local webserver listening on `localhost:8080` with hot-reload of your local changes.