nik/FreedomBox
1
0
Fork 0
mirror of https://github.com/freedombox/FreedomBox.git synced 2026-04-29 10:10:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Improve Developer Documentation index page

Browse Source 
- 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:
Joseph Nuthalapati 2021-02-23 01:10:39 +05:30 committed by James Valleroy
parent efbb39b2a3
commit 4b0899fd65
No known key found for this signature in database
GPG Key ID: 77C0C75E7B650808
1 changed files with 29 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

46
doc/dev/index.rst
View File

@ -1,18 +1,22 @@
.. SPDX-License-Identifier: CC-BY-SA-4.0 .. SPDX-License-Identifier: CC-BY-SA-4.0
FreedomBox Developer Documentation 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.
This manual is meant for developers intending to develop apps for FreedomBox. 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. 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:: .. toctree::
:maxdepth: 2 :maxdepth: 2
:caption: Contents
tutorial/index tutorial/index
reference/index reference/index
@ -30,16 +34,24 @@ External References
#. `FreedomBox User Manual <https://wiki.debian.org/FreedomBox/Manual>`_ #. `FreedomBox User Manual <https://wiki.debian.org/FreedomBox/Manual>`_
Contributing to this Documentation Indices
********************************** *******
.. toctree::
README
Indices and tables
******************
* :ref:`genindex` * :ref:`genindex`
* :ref:`modindex` * :ref:`modindex`
* :ref:`search`
Meta
****
.. toctree::
:maxdepth: 1
README
********
Websites
********
* `FreedomBox <https://freedombox.org>`_
* `FreedomBox Foundation <https://www.freedomboxfoundation.org>`_