michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: reorder the sections for better flow

Browse source 
Put the Developer Guides after the Getting Started guide, and make
sure the Application Development Primer is the first item in the
Developer Guides. Make some other ordering adjustments as well.

These changes collectively make for a more logical order for linearly
reading through the Zephyr documentation for the average user.
"Average user" here is defined as a person who wants to:

1. learn what Zephyr is and its distinguishing features
2. install a Zephyr development environment, building/running hello
   world
3. learn the basics of how Zephyr applications are structured
4. start diving deeper

This privileges "users" over "developers", i.e. it pushes sections
related to Zephyr's internals and how to edit them down lower in the
order.

Signed-off-by: Marti Bolivar <marti@foundries.io>
This commit is contained in:
Marti Bolivar 2018-10-12 14:55:02 -06:00 • committed by Anas Nashif
commit 23d12e9e68
2 changed files with 4 additions and 4 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/application/index.rst
View file

@ -6,11 +6,11 @@ Developer Guides
.. toctree::
:maxdepth: 1
../porting/porting.rst
application.rst
../samples/samples.rst
../reference/kconfig/index.rst
../api/api.rst
../porting/porting.rst
../README.rst
../west/index.rst
coccinelle.rst

6
doc/index.rst
View file

@ -50,13 +50,13 @@ Source code for the Zephyr Project is maintained in the Zephyr Project's
introduction/introducing_zephyr.rst
getting_started/getting_started.rst
contribute/contribute.rst
kernel/kernel.rst
security/security.rst
application/index.rst
boards/boards.rst
kernel/kernel.rst
devices/index.rst
subsystems/subsystems.rst
contribute/contribute.rst
security/security.rst
.. only:: html