Skip to content

Commit 005f5de

Browse files
iox-#1295 Rework overview article
1 parent ecb1179 commit 005f5de

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/website/getting-started/overview.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,8 @@ iox::popo::Subscriber<CounterTopic> subscriber({"Group", "Instance", "CounterTop
6666
```
6767
6868
Now we can use the subscriber to receive data. For simplicity, we assume that we periodically check for new data. It
69-
is also possible to explicitly wait for data using the [WaitSet](../../../iceoryx_examples/waitset/README.md) or
70-
the [Listener](../../../iceoryx_examples/callbacks/README.md). The code to receive the data is the same, the only difference is the way we wake up before checking for data.
69+
is also possible to explicitly wait for data using the [WaitSet](../examples/waitset.md) or
70+
the [Listener](../examples/callbacks.md). The code to receive the data is the same, the only difference is the way we wake up before checking for data.
7171
7272
```cpp
7373
while (keepRunning)
@@ -94,7 +94,7 @@ while (keepRunning)
9494
By calling `take` we get an `expected` and hence we have to handle the potential error.
9595

9696
And that's it. We have created our first simple iceoryx example.
97-
[Here](../../../iceoryx_examples/README.md) you can find further examples
97+
[Here](../examples/index.md) you can find further examples
9898
which demonstrate how iceoryx can be used and describe our API in more detail.
9999

100100
Now that we have applications capable of sending and receiving data, we can run the complete iceoryx system.
@@ -148,7 +148,7 @@ Shared memory is physical memory that is made accessible to multiple processes v
148148
virtual address spaces.
149149

150150
For further information have a look at our
151-
[shared memory concept article](../../shared-memory-communication.md).
151+
[shared memory concept article](https://github.com/eclipse-iceoryx/iceoryx/blob/v3.0.0/doc/shared-memory-communication.md).
152152

153153
### Runtime
154154

@@ -235,7 +235,7 @@ to process local constructs, no dynamic allocators
235235

236236
!!! info
237237
Most of the STL types cannot be used, but some are reimplemented to meet the conditions above.
238-
You can find an overview [here](../../../iceoryx_hoofs/README.md#cxx).
238+
You can find an overview [here](../advanced/iceoryx_hoofs.md#cxx).
239239

240240
### Publisher
241241

@@ -304,7 +304,7 @@ The WaitSet uses the [reactor pattern](https://en.wikipedia.org/wiki/Reactor_pat
304304
strategy that one of the attached events occured at which it informs the user.
305305

306306
For more information on how to use the WaitSet see our
307-
[WaitSet examples](../../../iceoryx_examples/waitset).
307+
[WaitSet examples](../examples/waitset.md).
308308

309309
### Listener
310310

@@ -326,13 +326,13 @@ connected callback that creates and sends a response, is executed.
326326
Like the WaitSet, the Listener uses the reactor pattern.
327327

328328
For more information about the Listener see our
329-
[callbacks example](../../../iceoryx_examples/callbacks).
329+
[callbacks example](../examples/callbacks.md).
330330

331331
## API
332332

333333
The API is offered in two languages, C++ and C. Detailed information can be found in the
334-
[C++ example](../../../iceoryx_examples/icedelivery) and
335-
[C example](../../../iceoryx_examples/icedelivery_in_c).
334+
[C++ example](../examples/icedelivery.md) and
335+
[C example](../examples/icedelivery_in_c.md).
336336

337337
Many parts of the C++ API follow a functional programming approach which is less error-prone. This requires using
338338
the monadic types `iox::expected` and `iox::optional` which are introduced

0 commit comments

Comments
 (0)