diff --git a/doc/website/.pages b/doc/website/.pages index a1f9abefb5..0891faf48e 100644 --- a/doc/website/.pages +++ b/doc/website/.pages @@ -7,4 +7,3 @@ nav: - FAQ.md - advanced - release-notes - - API-reference diff --git a/doc/website/FAQ.md b/doc/website/FAQ.md index cbf418a44b..56ae7268b8 100644 --- a/doc/website/FAQ.md +++ b/doc/website/FAQ.md @@ -4,7 +4,7 @@ In this document are tips and hints documented which can help for troubleshootin ## Does iceoryx run in a docker environment -Yes. Take a look at the [icedocker example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedelivery) +Yes. Take a look at the [icedocker example](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_examples/icedocker) ## iox-roudi fails on startup diff --git a/doc/website/advanced/configuration-guide.md b/doc/website/advanced/configuration-guide.md index 7428d128f3..26af903e79 100644 --- a/doc/website/advanced/configuration-guide.md +++ b/doc/website/advanced/configuration-guide.md @@ -15,7 +15,7 @@ These options adjust the limits of Publisher and Subscriber Ports for resource m | `IOX_MAX_CHUNKS_HELD_PER_SUBSCRIBER_SIMULTANEOUSLY` | Maximum number of chunks a subscriber can hold at a given time (subscriber history size)| | `IOX_MAX_INTERFACE_NUMBER` | Maximum number of interface ports which are used for gateways | -Have a look at [iceoryx_posh_deployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_posh/cmake/iceoryx_posh_deployment.cmake) for the default values of the constants. +Have a look at [IceoryxPoshDeployment.cmake](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/iceoryx_posh/cmake/IceoryxPoshDeployment.cmake) for the default values of the constants. !!! hint With the default values set, the size of `iceoryx_mgmt` is ~64.5 MByte. You can reduce the size by decreasing the values from the table via the CMake options. The current values are printed in the CMake stage when building iceoryx. diff --git a/doc/website/examples/icediscovery_in_c.md b/doc/website/examples/icediscovery_in_c.md index de0d67a29a..ef521bb817 100644 --- a/doc/website/examples/icediscovery_in_c.md +++ b/doc/website/examples/icediscovery_in_c.md @@ -2,4 +2,4 @@ title: Searching for currently available services using C --- -{! ../iceoryx/iceoryx_examples/icediscovery/README.md !} +{! ../iceoryx/iceoryx_examples/icediscovery_in_c/README.md !} diff --git a/doc/website/getting-started/overview.md b/doc/website/getting-started/overview.md index 11159218f3..c547ba48ef 100644 --- a/doc/website/getting-started/overview.md +++ b/doc/website/getting-started/overview.md @@ -67,9 +67,8 @@ iox::popo::Subscriber subscriber({"Group", "Instance", "CounterTop ``` Now we can use the subscriber to receive data. For simplicity, we assume that we periodically check for new data. It -is also possible to explicitly wait for data using the [WaitSet](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/waitset) -or the [Listener](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/design/listener.md). The code to -receive the data is the same, the only difference is the way we wake up before checking for data. +is also possible to explicitly wait for data using the [WaitSet](waitset.md) or the [Listener](callbacks.md). The +code to receive the data is the same, the only difference is the way we wake up before checking for data. ```cpp while (keepRunning) @@ -331,7 +330,7 @@ The API is offered in two languages, C++ and C. Detailed information can be foun Many parts of the C++ API follow a functional programming approach which is less error-prone. This requires using the monadic types `cxx::expected` and `cxx::optional` which are introduced -[here](https://github.com/eclipse-iceoryx/iceoryx/blob/v2.0.0/doc/website/concepts/how-optional-and-error-values-are-returned-in-iceoryx.md). +[here](how-optional-and-error-values-are-returned-in-iceoryx.md). With the C++ API, we distinguish between the `typed API` and the `untyped API`. In the typed API, the underlying data type is made apparent by typed pointers or references to some data type T (often a template parameter). This allows diff --git a/iceoryx_examples/icecrystal/Readme.md b/iceoryx_examples/icecrystal/Readme.md index 000a8ad41a..925ac0650f 100644 --- a/iceoryx_examples/icecrystal/Readme.md +++ b/iceoryx_examples/icecrystal/Readme.md @@ -19,7 +19,7 @@ We re-use the binaries from ## Feature walkthrough This example does not contain any additional code. The code of the `iceoryx_introspection_client` can be found under -[tools/introspection/](../../tools/introspection/). +[tools/introspection/](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/tools/introspection). The introspection can be started with several command line arguments. diff --git a/iceoryx_examples/icediscovery/README.md b/iceoryx_examples/icediscovery/README.md index d7de0c8ed1..cd210c4632 100644 --- a/iceoryx_examples/icediscovery/README.md +++ b/iceoryx_examples/icediscovery/README.md @@ -24,7 +24,7 @@ default. For more dynamism the `cameraPublishers` offer/stop their services periodically. If you want more information on how to create a publisher, have a look at the [icehello](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icehello), [icedelivery](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery), -and [iceoptions](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery) +and [iceoptions](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/iceoptions) examples. ### Find services diff --git a/iceoryx_examples/icediscovery_in_c/README.md b/iceoryx_examples/icediscovery_in_c/README.md index 40aa3f372f..43ef181490 100644 --- a/iceoryx_examples/icediscovery_in_c/README.md +++ b/iceoryx_examples/icediscovery_in_c/README.md @@ -5,7 +5,7 @@ This example demonstrates how to search for specific services using iceoryx's service discovery. It provides two applications - one offering different services and one searching for those with different search queries. The -behavior and structure is quite similar to the [icediscovery C++ example](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icedelivery). +behavior and structure is quite similar to the [icediscovery C++ example](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/icediscovery). diff --git a/iceoryx_examples/user_header/README.md b/iceoryx_examples/user_header/README.md index 8cac2f86d7..ff06a7464b 100644 --- a/iceoryx_examples/user_header/README.md +++ b/iceoryx_examples/user_header/README.md @@ -295,3 +295,6 @@ if (iox_sub_take_chunk(subscriber, &userPayload) == ChunkReceiveResult_SUCCESS) iox_sub_release_chunk(subscriber, userPayload); } ``` +
+[Check out User-Header on GitHub :fontawesome-brands-github:](https://github.com/eclipse-iceoryx/iceoryx/tree/v2.0.0/iceoryx_examples/user_header){ .md-button } +