eclipse-iceoryx / eclipse-iceoryx/iceoryx

Release validation for `v4.0`

Open
#2,403 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

## Website/Markdown settings

* [ ] Add `.markdownlint.yaml` file
* [ ] move fonts to the root folder and symlink them from everywhere else
* [ ] explore whether the same can be done with the assets
* [ ] split images into a root folder with common images and one for the specific versions for the rendered SVGs

## Examples

* [ ] Rework icedelivery
* [ ] Explain lifetime semantics of chunks/samples and user restrictions: loan needs to be followed with publish or release, MAX_CHUNKS_IN_USE on publisher and subscriber side etc., API is not thread-safe, update asciinema record (@MatthiasKillat)

## New articles

* [ ] How to write integration tests
* [ ] Performance results section

## Last tasks

Contributor guide

Open the contributing guide

Research direction

Start with the Website/Markdown settings checklist and the `icedelivery` example. Review the requested `.markdownlint.yaml`, font and asset layout, versioned SVG images, lifetime-semantics explanation, and asciinema update, then check the planned integration-test and performance-result articles. Done means the listed release-validation tasks are completed and checked off.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown, yaml
Domain
content, documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.