Merge branch 'dc' into 'master'

docs improvements

See merge request World/Phosh/squeekboard!547

README.md

@@ -86,4 +86,4 @@ It's strongly recommended to support:
 Developing
 ----------
 
-See [`doc/hacking.md`](doc/hacking.md) for this copy, or the [official documentation](https://developer.puri.sm/projects/squeekboard/) for the current release.
+See [`doc/hacking.md`](doc/hacking.md) for this copy, or the [official documentation](https://world.pages.gitlab.gnome.org/Phosh/squeekboard) for the current release.

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.

doc/index.md

@@ -1,13 +1,6 @@
 Welcome to squeekboard's documentation!
 =======================================
 
-Contents
---------
-
-* [Tutorial](tutorial.md)
-* [Contributing](hacking.md)
-* [Switching views](views.md)
-
 Introduction
 ------------
 
@@ -22,9 +15,15 @@ Layouts are created using a text-based format, based on YAML.
 
 TODO: Provide a description of the format.
 
+### Views
+
 Squeekboard layouts are separated into *views* and use a *room metaphor* to [switch views](views.md).
 
 Contributions
 -------------
 
 Anyone is free to modify *squeekboard*. See the [contributing document](hacking.md).
+
+### Code documentation
+
+To expose the structure of Squeekboard in detail, there's a [code reference](doc/rs).