doc: services: WIP clustering/grouping of services docs #100126
Draft
+982
−294
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
kartben
force-pushed
the
services_rst_intro
branch
13 times, most recently
from
8015eef to
b87e34e
Compare
"Connectivity" is an important aspect of Zephyr, but not to the point of being a top-level section in the documentation hierarchy. Moving it under "Services". Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
services_rst_intro
branch
from
b87e34e to
251110a
Compare
Modem API better fits under connectivity. Signed-off-by: Benjamin Cabé <[email protected]>
Source tree layout description should use :zephyr_file: since it creates hyperlinks to GitHub and, more importantly, the references are validated by the doc build so it guarantees they don't risk going stale. Signed-off-by: Benjamin Cabé <[email protected]>
Add more complete/dedicated documentation page for JWT API Signed-off-by: Benjamin Cabé <[email protected]>
Add more complete/dedicated documentation page for UUID API Signed-off-by: Benjamin Cabé <[email protected]>
Add sphinx-design to the list of Sphinx extensions in conf.py to enable additional design components for documentation, starting with cards. https://sphinx-design.readthedocs.io/en/latest/ Signed-off-by: Benjamin Cabé <[email protected]>
The very flat and unorganized list of services was really difficult to navigate, and not really helping people _discover_ services if they didn't already know what they were looking for. This tries to address that by adding some grouping. Signed-off-by: Benjamin Cabé <[email protected]>
kartben
force-pushed
the
services_rst_intro
branch
from
251110a to
cb33d1d
Compare
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WIP to add some categories to "OS Services" docs
https://builds.zephyrproject.io/zephyr/pr/100126/docs/services/index.html