Skip to content

Commit 3312147

Browse files
dbkinderMaureenHelm
authored andcommitted
doc: New developer getting started guide
As presented to the TSC, Zephyr's out-of-box experience for new developers is, well, complicated. A number of suggestions were presented including simplifying the getting started material to present a straight-forward path through the setup and installation steps through to getting a sample application built, flashed, and running. This PR is a work-in-progress towards addressing this OOB experience with a minimal-distractions version of the GSG. Alternatives, warnings, and material that could lead the developer astray were moved to alternative/advanced instruction documents (based on the previous separate Linux/macOS/Windows setup guides) and a new "Beyond the GSG" document. We do take advantage of a sphinx-tabs extension for synchronized tabs to present OS-specific instructions: clicking on one tab will display all same-named tabs throughout the doc. We hope (and will continue evaluating) that this new GSG gets developers set up quickly and then we can send them along to other documents to continue learning about Zephyr and trying other sample apps. Thanks for all your previous feedback that I've worked into this new version. Signed-off-by: David B. Kinder <[email protected]>
1 parent b4ddc10 commit 3312147

11 files changed

+798
-277
lines changed

README.rst

+2
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,8 @@ Community Support
4141
Community support is provided via mailing lists and Slack; see the Resources
4242
below for details.
4343

44+
.. _project-resources:
45+
4446
Resources
4547
*********
4648

doc/conf.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@
5151
'zephyr.application',
5252
'zephyr.html_redirects',
5353
'only.eager_only',
54-
'zephyr.link-roles'
54+
'zephyr.link-roles',
55+
'sphinx_tabs.tabs'
5556
]
5657

5758
# Only use SVG converter when it is really needed, e.g. LaTeX.
178 KB
Loading

0 commit comments

Comments
 (0)