-
Notifications
You must be signed in to change notification settings - Fork 444
Update MkDocs and documentation preparing for v3.0
release
#2398
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.
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
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2398 +/- ##
==========================================
- Coverage 78.68% 78.67% -0.02%
==========================================
Files 440 440
Lines 16986 16986
Branches 2361 2361
==========================================
- Hits 13365 13363 -2
- Misses 2740 2741 +1
- Partials 881 882 +1
Flags with carried forward coverage won't be shown. Click here to find out more. |
de9ce86
to
4c7e44f
Compare
d975517
to
8aa9f69
Compare
6e2bdbb
to
bbf7136
Compare
@elBoberido Ready for review. The documentation is completely fixed. Please do the full review on this PR. Once the findings are addressed I'll merge only the commits without |
bbf7136
to
2ed509b
Compare
445e570
to
d46678e
Compare
To go ahead and get this merged, I cut out the links for MkDocs which could be going to |
@budrus @elBoberido Thanks for the review 🙏 I addressed your findings. Back to you. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Did you already revert the extraction of iceoryx-unreleased.md
to iceoryx-v3-0-0-unreleased.md
…e new articles as well as release notes
4ef68e3
to
baf1547
Compare
Notes for Reviewer
Update MkDocs and documentation preparing for
v3.0
releaseToDo
Check all links=> Proposal: only to be merged onrelease_3.0
branchiceoryx_release.sh
inv3.0
#1295Create release branchNot as part of this PRrelease_3.0
Prepare ROS 2 releaseNot as part of this PRPre-Review Checklist for the PR Author
Code follows the coding style of CONTRIBUTING.mdTests follow the best practice for testingiox-123-this-is-a-branch
)iox-#123 commit text
)task-list-completed
)Checklist for the PR Reviewer
Consider a second reviewer for complex new features or larger refactoringsCode according to our coding style and naming conventionsUnit tests have been written for new behaviorPublic API changes are documented via doxygenCopyright owner are updated in the changed filesAll touched (C/C++) source code files fromiceoryx_hoofs
have been added to./clang-tidy-diff-scans.txt
Post-review Checklist for the PR Author
References
v3.0
#1295