[#4] prepare documentation for release

[elfenpiff]

Notes for Reviewer

Pre-Review Checklist for the PR Author

1. Add sensible notes for the reviewer
2. PR title is short, expressive and meaningful
3. Relevant issues are linked in the References section
4. Every source code file has a copyright header with SPDX-License-Identifier: Apache-2.0 OR MIT
5. Branch follows the naming format (iox2-123-introduce-posix-ipc-example)
6. Commits messages are according to this guideline
   • Commit messages have the issue ID ([#123] Add posix ipc example)
   • Commit author matches Eclipse Contributor Agreement (and ECA is signed)
7. Tests follow the best practice for testing
8. Changelog updated in the unreleased section including API breaking changes
9. Assign PR to reviewer
10. All checks have passed (except task-list-completed)

Checklist for the PR Reviewer

• Commits are properly organized and messages are according to the guideline
• Unit tests have been written for new behavior
• Public API is documented
• PR title describes the changes

Post-review Checklist for the PR Author

1. All open points are addressed and tracked via issues

References

Relates to #4

[codecov]

Codecov Report

Attention: Patch coverage is 81.08108% with 28 lines in your changes are missing coverage. Please review.

Project coverage is 78.56%. Comparing base (b0a28c6) to head (ea11d0b).

❗ Current head ea11d0b differs from pull request most recent head aee0283. Consider uploading reports for the commit aee0283 to get more accurate results

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #189      +/-   ##
==========================================
- Coverage   78.64%   78.56%   -0.08%     
==========================================
  Files         181      181              
  Lines       19922    19933      +11     
==========================================
- Hits        15667    15660       -7     
- Misses       4255     4273      +18     

Files	Coverage Δ
iceoryx2-bb/container/src/byte_string.rs	89.78% <ø> (ø)
iceoryx2-bb/container/src/vec.rs	90.54% <100.00%> (ø)
iceoryx2-bb/posix/src/directory.rs	62.55% <ø> (ø)
iceoryx2-bb/posix/src/message_queue.rs	76.62% <ø> (ø)
...c/dynamic_storage/dynamic_storage_configuration.rs	66.00% <ø> (ø)
iceoryx2-cal/src/named_concept.rs	78.84% <ø> (ø)
iceoryx2/src/iox2.rs	0.00% <ø> (ø)
iceoryx2/src/port/port_identifiers.rs	87.50% <ø> (ø)
iceoryx2/src/port/publisher.rs	82.89% <100.00%> (ø)
iceoryx2/src/sample.rs	70.83% <ø> (ø)
... and 12 more

... and 4 files with indirect coverage changes