Skip to content

Commit cb29775

Browse files
committed
doc/guides/general: switch out @ref usage
1 parent a1816a7 commit cb29775

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

doc/guides/general/structure.mdx

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ This directory contains the actual kernel. The kernel consists of the scheduler,
3333
inter-process-communication (messaging), threading, and thread
3434
synchronization, as well as supporting data-structures and type definitions.
3535

36-
See @ref core for further information and API documentations.
36+
See [Kernel](https://doc.riot-os.org/group__core.html) for further information and API documentations.
3737

3838
boards
3939
------
@@ -53,7 +53,7 @@ interfacing with the board. These are typically custom flash/debug scripts or
5353
e.g. OpenOCD configuration files. For most boards, these files are located in a
5454
`dist` sub-directory of the board.
5555

56-
See here @ref boards for further information.
56+
See here [Boards](https://doc.riot-os.org/group__boards.html) for further information.
5757

5858
cpu
5959
---
@@ -65,7 +65,7 @@ switching) code. For most CPUs you will also find the linker scripts in the
6565
`ldscripts` sub-directory.
6666

6767
In the `periph` sub-directory of each CPU you can find the implementations of
68-
the CPU's peripheral drivers like SPI, UART, GPIO, etc. See @ref drivers_periph
68+
the CPU's peripheral drivers like SPI, UART, GPIO, etc. See [Peripheral Driver Interface](https://doc.riot-os.org/group__drivers__periph.html)
6969
for their API documentation.
7070

7171
Many CPUs share a certain amount of their code (e.g. all ARM Cortex-M based
@@ -75,7 +75,7 @@ scheme. Examples for this is code shared across architectures (e.g.
7575
`cortexm_common`, `msp430_comon`) or code shared among vendors (e.g.
7676
`stm32_common`).
7777

78-
See @ref cpu for more detailed information.
78+
See [CPU](https://doc.riot-os.org/build-system-basics.html#cpu) for more detailed information.
7979

8080
drivers
8181
-------
@@ -88,7 +88,7 @@ GPIO, etc.) and other RIOT modules like the `xtimer`. This way the drivers are
8888
completely platform agnostic and they don't have any dependencies into the CPU
8989
and board code.
9090

91-
See @ref drivers for more details.
91+
See [Drivers](https://doc.riot-os.org/group__drivers.html) for more details.
9292

9393
sys
9494
---
@@ -99,16 +99,16 @@ structures (e.g. bloom, color), crypto libraries (e.g. hashes, AES) ,
9999
high-level APIs (e.g. Posix implementations), memory management (e.g. malloc),
100100
the RIOT shell and many more.
101101

102-
See @ref sys for a complete list of available libraries
102+
See [System](https://doc.riot-os.org/group__sys.html) for a complete list of available libraries
103103

104104
sys/net
105105
-------
106106
The `sys/net` sub-directory needs to be explicitly mentioned, as this is where
107107
all the networking code in RIOT resides. Here you can find the network stack
108-
implementations (e.g. the @ref net_gnrc "GNRC" stack) as well as network stack agnostic code as
108+
implementations (e.g. the "[GNRC](https://doc.riot-os.org/group__net__gnrc.html)" stack) as well as network stack agnostic code as
109109
header definitions or network types.
110110

111-
See @ref net for more details on networking code.
111+
See [Networking](https://doc.riot-os.org/group__net.html) for more details on networking code.
112112

113113
pkg
114114
---
@@ -120,7 +120,7 @@ downloads the library and optionally applies a number of patches to make it
120120
work with RIOT. These Makefiles and patches can be found in the `pkg`
121121
directory.
122122

123-
See @ref pkg for a detailed description on how this works.
123+
See [Packages](https://doc.riot-os.org/group__pkg.html) for a detailed description on how this works.
124124

125125
examples
126126
--------
@@ -131,7 +131,7 @@ starting point for anyone who is new to RIOT.
131131
For more information best browse that directory and have a look at the
132132
`README.md` files that ship with each example.
133133

134-
To create your own application - here or anywhere else - see @ref creating-an-application
134+
To create your own application - here or anywhere else - see [Setup Development Environment](https://guide.riot-os.org/getting-started/installing/)
135135

136136
tests
137137
-----

0 commit comments

Comments
 (0)