From 6867f48bf9f8e9cc1e409709808d22fd10f2c8a3 Mon Sep 17 00:00:00 2001 From: Dorota Czaplejewicz Date: Sun, 17 Apr 2022 07:35:32 +0000 Subject: [PATCH] docs: Make index more logical --- doc/index.md | 14 ++++++-------- 1 file changed, 6 insertions(+), 8 deletions(-) diff --git a/doc/index.md b/doc/index.md index 25b841cf..a7f20823 100644 --- a/doc/index.md +++ b/doc/index.md @@ -1,14 +1,6 @@ Welcome to squeekboard's documentation! ======================================= -Contents --------- - -* [Tutorial](tutorial.md) -* [Contributing](hacking.md) -* [Switching views](views.md) -* [Reference](doc/rs/) - Introduction ------------ @@ -23,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). \ No newline at end of file