mirror of
https://github.com/freedombox/FreedomBox.git
synced 2026-01-21 07:55:00 +00:00
docs: Improve Developer Documentation index page
- Improved readability. - Changed hierarchy of headings. - Reduced emphasis on unnecessary/redundant things. - Added links to go back to the main websites. Signed-off-by: Joseph Nuthalapati <njoseph@riseup.net> Reviewed-by: James Valleroy <jvalleroy@mailbox.org>
This commit is contained in:
parent
efbb39b2a3
commit
4b0899fd65
@ -1,18 +1,22 @@
|
||||
.. SPDX-License-Identifier: CC-BY-SA-4.0
|
||||
|
||||
FreedomBox Developer Documentation
|
||||
==================================
|
||||
|
||||
**Note:** If you are looking for documentation on using FreedomBox, please visit
|
||||
the `FreedomBox Manual <https://wiki.debian.org/FreedomBox/Manual>`__. You can
|
||||
also find a copy of the user manual in the help section of your FreedomBox.
|
||||
Developer Documentation
|
||||
=========================
|
||||
|
||||
This manual is meant for developers intending to develop apps for FreedomBox.
|
||||
It provides an API reference and a step-by-step tutorial for developing apps.
|
||||
|
||||
|
||||
**Note:** If you are looking for documentation on using FreedomBox, please visit
|
||||
the `FreedomBox Manual <https://wiki.debian.org/FreedomBox/Manual>`_. You can
|
||||
also find a copy of the user manual in the help section of your FreedomBox.
|
||||
|
||||
********
|
||||
Contents
|
||||
********
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents
|
||||
|
||||
tutorial/index
|
||||
reference/index
|
||||
@ -30,16 +34,24 @@ External References
|
||||
|
||||
#. `FreedomBox User Manual <https://wiki.debian.org/FreedomBox/Manual>`_
|
||||
|
||||
Contributing to this Documentation
|
||||
**********************************
|
||||
|
||||
.. toctree::
|
||||
|
||||
README
|
||||
|
||||
Indices and tables
|
||||
******************
|
||||
Indices
|
||||
*******
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
Meta
|
||||
****
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
README
|
||||
|
||||
********
|
||||
Websites
|
||||
********
|
||||
|
||||
* `FreedomBox <https://freedombox.org>`_
|
||||
|
||||
* `FreedomBox Foundation <https://www.freedomboxfoundation.org>`_
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user