From faf5f46a358b3cecffd6de985f703b4df81adb30 Mon Sep 17 00:00:00 2001
From: Franck Royer <franck@status.im>
Date: Mon, 10 May 2021 16:52:53 +1000
Subject: [PATCH] Deploy docs on GH Pages

---
 .github/workflows/deploy-gh-pages.yml | 11 +++++++++++
 README.md                             | 11 +++++++++++
 2 files changed, 22 insertions(+)

diff --git a/.github/workflows/deploy-gh-pages.yml b/.github/workflows/deploy-gh-pages.yml
index 15c5a2dadd..050a87edb6 100644
--- a/.github/workflows/deploy-gh-pages.yml
+++ b/.github/workflows/deploy-gh-pages.yml
@@ -48,3 +48,14 @@ jobs:
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: ./examples/web-chat/build
+
+      - name: Generate docs
+        run: npm run doc:html
+
+      - name: Deploy documentation on gh pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          keep_files: true # Do not delete web chat app
+          publish_dir: ./build/docs
+          destination_dir: docs
diff --git a/README.md b/README.md
index d2b274bb87..6442d6e6f0 100644
--- a/README.md
+++ b/README.md
@@ -2,6 +2,17 @@
 
 A JavaScript implementation of the [Waku v2 protocol](https://specs.vac.dev/specs/waku/v2/waku-v2).
 
+## Documentation
+
+Latest `main` branch documentation can be found at [https://status-im.github.io/js-waku/docs/](https://status-im.github.io/js-waku/docs/).
+
+Docs can also be generated locally using:
+
+```shell
+npm install
+npm run doc
+```
+
 ## Waku Protocol Support
 
 You can track progress on the [project board](https://github.com/status-im/js-waku/projects/1).