s3rius/squeekboard
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Make index more logical

Browse Source
This commit is contained in:
Dorota Czaplejewicz
2022-04-17 07:35:32 +00:00
parent 71942f7221
commit 6867f48bf9
1 changed files with 6 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
doc/index.md
View File

@ -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).