eclipse-iceoryx / eclipse-iceoryx/iceoryx

Design document for WaitSet

Open
#1,238 0 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
C++
Stars
2.2k
Forks
492
Avg merge
18h 57m
Merged PRs (30d)
1

Description

## Brief feature description

Many examples and some other readmes refer to the WaitSet example readme. It would be better to have a design document for the WaitSet to link to. This should also include the [Glossary](https://github.com/eclipse-iceoryx/iceoryx/tree/master/iceoryx_examples/waitset#glossary).

Contributor guide

Open the contributing guide

Research direction

Start by reading the WaitSet example README under iceoryx_examples/waitset, including its Glossary, and identify the existing examples and READMEs that refer to it. Create a design document covering the WaitSet and the Glossary, then verify that the relevant references can link to the new document.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.