23d12e9e68
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>
75 lines
2.1 KiB
ReStructuredText
75 lines
2.1 KiB
ReStructuredText
..
|
|
Zephyr Project documentation master file
|
|
|
|
Zephyr Project Documentation
|
|
############################
|
|
|
|
.. only:: release
|
|
|
|
Welcome to the Zephyr Project's documentation version |version|!
|
|
|
|
Documentation for the development branch of Zephyr can be found at
|
|
https://docs.zephyrproject.org/
|
|
|
|
.. only:: (development or daily)
|
|
|
|
Welcome to the Zephyr Project's documentation. This is the documentation of the
|
|
master tree under development (version |version|).
|
|
|
|
Documentation for tagged released versions of Zephyr can be found at
|
|
``https://docs.zephyrproject.org/<version>``. The following documentation
|
|
versions are available:
|
|
|
|
`Zephyr 1.9.2`_ | `Zephyr 1.10.0`_ | `Zephyr 1.11.0`_ |
|
|
`Zephyr 1.12.0`_ | `Zephyr 1.13.0`_
|
|
|
|
For information about the changes and additions for releases, please
|
|
consult the published :ref:`zephyr_release_notes` documentation.
|
|
|
|
The Zephyr OS is provided under the `Apache 2.0 license`_ (as found in
|
|
the LICENSE file in the project's `GitHub repo`_). The Zephyr OS also
|
|
imports or reuses packages, scripts, and other files that use other
|
|
licensing, as described in :ref:`Zephyr_Licensing`.
|
|
|
|
Source code for the Zephyr Project is maintained in the Zephyr Project's
|
|
`GitHub repo`_.
|
|
|
|
.. _Apache 2.0 license:
|
|
https://github.com/zephyrproject-rtos/zephyr/blob/master/LICENSE
|
|
|
|
.. _GitHub repo: https://github.com/zephyrproject-rtos/zephyr
|
|
|
|
|
|
.. only:: html
|
|
|
|
Sections
|
|
********
|
|
|
|
.. toctree::
|
|
:maxdepth: 1
|
|
|
|
introduction/introducing_zephyr.rst
|
|
getting_started/getting_started.rst
|
|
application/index.rst
|
|
boards/boards.rst
|
|
kernel/kernel.rst
|
|
devices/index.rst
|
|
subsystems/subsystems.rst
|
|
contribute/contribute.rst
|
|
security/security.rst
|
|
|
|
.. only:: html
|
|
|
|
Indices and Tables
|
|
******************
|
|
|
|
* :ref:`glossary`
|
|
|
|
* :ref:`genindex`
|
|
|
|
.. _Zephyr 1.13.0: https://docs.zephyrproject.org/1.13.0/
|
|
.. _Zephyr 1.12.0: https://docs.zephyrproject.org/1.12.0/
|
|
.. _Zephyr 1.11.0: https://docs.zephyrproject.org/1.11.0/
|
|
.. _Zephyr 1.10.0: https://docs.zephyrproject.org/1.10.0/
|
|
.. _Zephyr 1.9.2: https://docs.zephyrproject.org/1.9.0/
|