From 71942f72217f53ffe50d5d74195d3037d17505c4 Mon Sep 17 00:00:00 2001
From: Dorota Czaplejewicz <dorota.czaplejewicz@puri.sm>
Date: Sun, 17 Apr 2022 07:31:29 +0000
Subject: [PATCH] docs: Link to reference

---
 doc/hacking.md | 11 +++++++++++
 doc/index.md   |  1 +
 2 files changed, 12 insertions(+)

diff --git a/doc/hacking.md b/doc/hacking.md
index 6db78b68..70301a2c 100644
--- a/doc/hacking.md
+++ b/doc/hacking.md
@@ -102,6 +102,17 @@ contain a comma separated list of:
 Coding
 ------
 
+### Reference docs
+
+Reference documentation can be generated using:
+
+```
+cd squeekboard_build/ 
+../squeekboard_source/cargo.sh doc --no-deps --document-private-items
+```
+
+as well as found [online](https://world.pages.gitlab.gnome.org/Phosh/squeekboard/doc/rs/).
+
 ### Project structure
 
 Rust modules should be split into 2 categories: libraries, and user interface. They differ in the way they do error handling.
diff --git a/doc/index.md b/doc/index.md
index fdf4dcbe..25b841cf 100644
--- a/doc/index.md
+++ b/doc/index.md
@@ -7,6 +7,7 @@ Contents
 * [Tutorial](tutorial.md)
 * [Contributing](hacking.md)
 * [Switching views](views.md)
+* [Reference](doc/rs/)
 
 Introduction
 ------------