OrgZephyr/zephyr
OrgZephyr
/
zephyr
mirror of https://github.com/zephyrproject-rtos/zephyr.git
1
0
Fork 0
Code Issues Releases Wiki Activity
zephyr/doc/guides/index.rst

31 lines
495 B
ReStructuredText
Raw Normal View History

doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 00:06:11 +08:00
.. _user_guides:
User and Developer Guides
#########################
.. toctree::
:maxdepth: 1
doc: guides: add "Asking for Help" guide I often wish I had a short and Zephyr-specific place to point people to when they're asking for help in ways that make it hard to help them. Add one. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-04-18 02:54:17 +08:00
getting-help.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 00:06:11 +08:00
bluetooth/index.rst
c_library
../README.rst
coccinelle.rst
code-relocation.rst
doc: add orphaned crypto docs tinycrypt documentation wasn't included in the table of contents so add it into the guides section. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-04-11 06:29:07 +08:00
crypto/index
doc: debugging: Introduce guide covering debug probes and host tools Zephyr boards use a wide range of debug probes and debug host tools that can often be confusing to users. Introduce a new debugging guide that documents all the different variations of debug probes and host tools in one place, including which combinations are valid. Signed-off-by: Maureen Helm <maureen.helm@nxp.com>
2019-03-02 04:17:25 +08:00
debugging/index
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 00:06:11 +08:00
device_mgmt/index
device_mgmt/dfu
documentation/index
dts/index
doc: unify documentation on setting environment variables There are a few different places where alternatives for setting environment variables are described. None of them is 100% complete, so the results are likely to be confusing. Make a single page on setting environment variables, how the zephyrrc files work, how the zephyr-env scripts work, and some of the important environment variables, with appropriate references elsewhere. (This is inspired by the Arch wiki's excellent page on installing programs.) Link to it from the getting started and application development pages instead of repeating the information. This has the benefit of shortening the getting started guide a bit more. Add some concrete advice on checking the toolchain environment variables in particular. This is a stumbling block for beginners. Signed-off-by: Marti Bolivar <marti.bolivar@nordicsemi.no>
2019-05-07 13:36:30 +08:00
env_vars.rst
doc: Add more coverage documentation Add more documentation about how to generate coverage reports for POSIX arch based boards Signed-off-by: Alberto Escolar Piedras <alpi@oticon.com>
2019-02-20 23:04:14 +08:00
coverage.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 00:06:11 +08:00
kconfig/index
doc: move module related doc to guides Move to a new guide which will expand on how to submit modules and how to maintain them. Also move topology documentation to repository management section where it fits better. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-10 22:27:59 +08:00
modules.rst
doc: introduce final structure Move guides and APIs into separate directories and cleanup naming introducing index files rather than named section files. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-02-03 00:06:11 +08:00
networking/index
porting/index
test/index
tracing/index
west/index
doc: guide for optimizing zephyr Add section about how to optimize Zephyr for footprint. Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2019-05-03 21:02:50 +08:00
optimizations/index