Skip to content

Commit fe8ba64

Browse files
committed
doc: services: add structure/categorization to services index
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]>
1 parent e5ce904 commit fe8ba64

File tree

1 file changed

+177
-27
lines changed

1 file changed

+177
-27
lines changed

doc/services/index.rst

Lines changed: 177 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -3,42 +3,192 @@
33
OS Services
44
###########
55

6+
Zephyr provides a comprehensive set of subsystems and associated services that applications can
7+
leverage.
8+
9+
.. will move the CSS below to custom.css when done with experimenting :)
10+
11+
.. raw:: html
12+
13+
<style>
14+
.sd-card {
15+
background-color: var(--navbar-background-color);
16+
border-radius: 0.75rem !important;
17+
border: 1px solid transparent;
18+
transition: all 0.15s ease;
19+
box-shadow: none !important;
20+
}
21+
.sd-card:hover {
22+
transform: translateY(-3px);
23+
box-shadow: 0 6px 12px rgba(0, 0, 0, 0.25) !important;
24+
border-color: rgba(255, 255, 255, 0.05);
25+
}
26+
.sd-card-title {
27+
font-size: 1.125rem !important;
28+
font-weight: bold !important;
29+
margin-bottom: 0.25rem !important;
30+
color: #fff !important;
31+
}
32+
.sd-card-text {
33+
color: var(--navbar-level-1-color) !important;
34+
font-weight: 300 !important;
35+
font-size: 0.9rem !important;
36+
margin: 0 !important;
37+
opacity: 0.85;
38+
}
39+
</style>
40+
41+
.. grid:: 1 1 2 2
42+
:gutter: 2
43+
44+
.. grid-item-card:: :material-twotone:`memory;36px` System
45+
:link: system_services
46+
:link-type: ref
47+
48+
Memory management, low-level infrastructure, and other utility APIs.
49+
50+
.. grid-item-card:: :material-twotone:`sync;36px` Data Processing
51+
:link: data_processing_services
52+
:link-type: ref
53+
54+
Data transformation, encoding, and validation APIs.
55+
56+
.. grid-item-card:: :material-twotone:`bug_report;36px` Debugging & Observability
57+
:link: debugging_observability_services
58+
:link-type: ref
59+
60+
Logging, tracing, shell, and other debugging and observability tools.
61+
62+
.. grid-item-card:: :material-twotone:`battery_charging_30;36px` Power Management
63+
:link: power_management_services
64+
:link-type: ref
65+
66+
Energy consumption, performance scaling, and resource lifecycle control.
67+
68+
.. grid-item-card:: :material-twotone:`save;36px` Storage
69+
:link: storage_reference
70+
:link-type: ref
71+
72+
Flash access, file systems, key-value stores, and persistent data.
73+
74+
.. grid-item-card:: :material-twotone:`mail;36px` Communication
75+
:link: communication_services
76+
:link-type: ref
77+
78+
Inter-thread, inter-processor, and external communication mechanisms.
79+
80+
.. grid-item-card:: :material-twotone:`security;36px` Security
81+
:link: security_services
82+
:link-type: ref
83+
84+
Cryptographic primitives and trusted execution environments.
85+
86+
.. grid-item-card:: :material-twotone:`widgets;36px` Application Services
87+
:link: application_framework_services
88+
:link-type: ref
89+
90+
High-level frameworks and libraries for application development.
91+
92+
.. toctree::
93+
:maxdepth: 2
94+
:hidden:
95+
96+
storage/index.rst
97+
98+
.. _system_services:
99+
100+
System
101+
******
102+
6103
.. toctree::
7104
:maxdepth: 1
8105

106+
mem_mgmt/index.rst
107+
net_buf/index.rst
108+
rtio/index.rst
109+
notify.rst
9110
binary_descriptors/index.rst
10-
console.rst
11-
cpu_freq/index.rst
12-
cpu_load/index.rst
111+
portability/index.rst
112+
task_wdt/index.rst
113+
114+
.. _data_processing_services:
115+
116+
Data Processing
117+
***************
118+
119+
.. toctree::
120+
:maxdepth: 1
121+
13122
crc/index.rst
14-
crypto/index
15-
debugging/index.rst
16-
device_mgmt/index
17123
dsp/index.rst
18-
formatted_output.rst
19-
input/index.rst
20-
instrumentation/index.rst
21-
ipc/index.rst
22-
llext/index.rst
124+
serialization/index.rst
125+
misc.rst
126+
127+
.. _debugging_observability_services:
128+
129+
Debugging & Observability
130+
*************************
131+
132+
.. toctree::
133+
:maxdepth: 1
134+
23135
logging/index.rst
24136
tracing/index.rst
25-
resource_management/index.rst
26-
mem_mgmt/index.rst
27-
net_buf/index.rst
28-
modem/index.rst
29-
notify.rst
30-
pm/index.rst
31-
portability/index.rst
32-
poweroff.rst
137+
debugging/index.rst
33138
profiling/index.rst
139+
instrumentation/index.rst
140+
cpu_load/index.rst
34141
shell/index.rst
35-
serialization/index.rst
142+
143+
.. _power_management_services:
144+
145+
Power Management
146+
****************
147+
148+
.. toctree::
149+
:maxdepth: 1
150+
151+
pm/index.rst
152+
cpu_freq/index.rst
153+
poweroff.rst
154+
resource_management/index.rst
155+
156+
.. _communication_services:
157+
158+
Communication
159+
*************
160+
161+
.. toctree::
162+
:maxdepth: 1
163+
164+
zbus/index.rst
165+
ipc/index.rst
166+
modem/index.rst
167+
virtualization/index.rst
168+
console.rst
169+
input/index.rst
170+
formatted_output.rst
171+
172+
.. _security_services:
173+
174+
Security
175+
********
176+
177+
.. toctree::
178+
:maxdepth: 1
179+
180+
crypto/index
181+
tfm/index
182+
183+
.. _application_framework_services:
184+
185+
Application Services
186+
********************
187+
188+
.. toctree::
189+
:maxdepth: 1
190+
36191
smf/index.rst
37-
storage/index.rst
38192
sensing/index.rst
39-
task_wdt/index.rst
40-
tfm/index
41-
virtualization/index.rst
42-
rtio/index.rst
43-
zbus/index.rst
44-
misc.rst
193+
device_mgmt/index
194+
llext/index.rst

0 commit comments

Comments
 (0)