eclipse-iceoryx / eclipse-iceoryx/iceoryx2

Improved Getting Started Documentation

Open
#446 0 comments 0 reactions 0 assignees View on GitHub
documentation enhancement
Dominant language
Rust
Stars
2.5k
Forks
185
Avg merge
1d 23h
Merged PRs (30d)
47

Description

## Improvement Suggestion

In https://iceoryx2.readthedocs.io and also our examples we need to clearly define the restrictions on the payload type. On the Rust side we can solve this cleanly with the `shmem` derive macro but on the C/C++ side we must document it.

It already led to a bug; see #436, so this shall be done sooner rather than later. Otherwise, another user will also run into this pitfall.

Contributor guide

Open the contributing guide

Research direction

Review the Getting Started documentation at https://iceoryx2.readthedocs.io and the repository examples, then inspect the shmem derive macro and issue #436 for the payload restriction context. Done means clearly documenting the allowed payload types and restrictions for Rust, C, and C++ users in both the documentation and examples.

Written by the indexing model from the issue text.

Assessment

Tech stack
c, cpp, rust
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.