Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update MkDocs and documentation preparing for v3.0 release #2398

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Fix doxygen generation

de9ce86
Select commit
Loading
Failed to load commit list.
Draft

Update MkDocs and documentation preparing for v3.0 release #2398

Fix doxygen generation
de9ce86
Select commit
Loading
Failed to load commit list.
Task list completed / task-list-completed Started 2025-01-06 11:26:36 ago

5 / 26 tasks completed

21 tasks still to be completed

Details

Required Tasks

Task Status
Update version of MkDocs material related packages Incomplete
Fix HTML footer Incomplete
Check all links => Proposal: to be done on release_3.0 branch Completed
Run iceoryx_release.sh in Completed
Go through items in #1295 Incomplete
Create release branch release_3.0 (Before fixing the relative links?) Incomplete
Write release notes Incomplete
Check ascinema recordings Incomplete
Prepare ROS 2 release Incomplete
Code follows the coding style of [CONTRIBUTING.md][contributing] Completed
Tests follow the [best practice for testing][testing] Completed
Changelog updated [in the unreleased section][changelog] including API breaking changes Incomplete
Branch follows the naming format (iox-123-this-is-a-branch) Completed
Commit messages have the issue ID (iox-#123 commit text) Incomplete
Commit author matches [Eclipse Contributor Agreement][eca] (and ECA is signed) Incomplete
Follow the same conventions as for commit messages Incomplete
Link to the relevant issue Incomplete
Relevant issues are linked Incomplete
Add sensible notes for the reviewer Incomplete
All checks have passed (except task-list-completed) Incomplete
Assign PR to reviewer Incomplete
Consider a second reviewer for complex new features or larger refactorings Incomplete
Commits are properly organized and messages are according to the guideline Incomplete
Code according to our coding style and naming conventions Incomplete
Unit tests have been written for new behavior Incomplete
Public API changes are documented via doxygen Incomplete
Copyright owner are updated in the changed files Incomplete
All touched (C/C++) source code files from iceoryx_hoofs have been added to ./clang-tidy-diff-scans.txt Incomplete
PR title describes the changes Incomplete
All open points are addressed and tracked via issues Incomplete
Closes #1295 Incomplete
View more details on Task list completed