Add `not_in_nav` section to mkdocs.yml

glenn-jocher commented 1 week ago

🛠️ PR Summary

_{Made with ❤️ by Ultralytics Actions}

🌟 Summary

Updated the documentation configuration to exclude specific pages from the navigation menu.

📊 Key Changes

Added /compare and /macros to the not_in_nav section of the mkdocs.yml configuration file.

🎯 Purpose & Impact

📝 Improved Navigation: Ensures that certain auxiliary or inaccessible pages, like /compare and /macros, are hidden from the main navigation menu, reducing clutter.
🔍 Enhanced User Experience: Helps users focus on the core documentation pages, making the interface cleaner and more user-friendly.

UltralyticsAssistant commented 1 week ago

👋 Hello @glenn-jocher, thank you for submitting an ultralytics/ultralytics 🚀 PR! To ensure a seamless integration of your work, please review the following checklist:

✅ Define a Purpose: Clearly explain the purpose of your fix or feature in your PR description, and link to any relevant issues. Ensure your commit messages are clear, concise, and adhere to the project's conventions.
✅ Synchronize with Source: Confirm your PR is synchronized with the ultralytics/ultralytics main branch. If it's behind, update it by clicking the 'Update branch' button or by running git pull and git merge main locally.
✅ Ensure CI Checks Pass: Verify all Ultralytics Continuous Integration (CI) checks are passing. If any checks fail, please address the issues.
✅ Update Documentation: Update the relevant documentation for any new or modified features.
✅ Add Tests: If applicable, include or update tests to cover your changes, and confirm that all tests are passing.
✅ Sign the CLA: Please ensure you have signed our Contributor License Agreement if this is your first Ultralytics PR by writing "I have read the CLA Document and I sign the CLA" in a new message.
✅ Minimize Changes: Limit your changes to the minimum necessary for your bug fix or feature addition. "It is not daily increase but daily decrease, hack away the unessential. The closer to the source, the less wastage there is." — Bruce Lee

For more guidance, please refer to our Contributing Guide. Don’t hesitate to leave a comment if you have any questions. An Ultralytics engineer will also review this PR soon. Thank you for contributing to Ultralytics! 🚀

codecov[bot] commented 1 week ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 73.12%. Comparing base (5db36db) to head (c1e205a). Report is 1 commits behind head on main.

:exclamation: There is a different number of reports uploaded between BASE (5db36db) and HEAD (c1e205a). Click for more details.

HEAD has 9 uploads less than BASE
| Flag | BASE (5db36db) | HEAD (c1e205a) | |------|------|------| |GPU|2|1| |Tests|10|5| |Benchmarks|6|3|

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #19068 +/- ## ========================================== - Coverage 78.12% 73.12% -5.01% ========================================== Files 129 129 Lines 17486 17486 ========================================== - Hits 13661 12786 -875 - Misses 3825 4700 +875 ``` | [Flag](https://app.codecov.io/gh/ultralytics/ultralytics/pull/19068/flags?src=pr&el=flags&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | Coverage Δ | | |---|---|---| | [Benchmarks](https://app.codecov.io/gh/ultralytics/ultralytics/pull/19068/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `34.12% <ø> (ø)` | | | [GPU](https://app.codecov.io/gh/ultralytics/ultralytics/pull/19068/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `37.95% <ø> (-2.71%)` | :arrow_down: | | [Tests](https://app.codecov.io/gh/ultralytics/ultralytics/pull/19068/flags?src=pr&el=flag&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics) | `66.91% <ø> (-5.16%)` | :arrow_down: | Flags with carried forward coverage won't be shown. [Click here](https://docs.codecov.io/docs/carryforward-flags?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=ultralytics#carryforward-flags-in-the-pull-request-comment) to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

glenn-jocher commented 1 week ago

Eliminates warnings around docs pages present in build but not in nav.

glenn-jocher commented 1 week ago

@RizwanMunawar adding this to suppress missing pages warning, but unrelated to failing tests, not intended to solve them.

UltralyticsAssistant commented 1 week ago

🌟 Thank you, @glenn-jocher, for another stellar contribution!

"Perfection is not attainable, but if we chase perfection, we can catch excellence." – Vince Lombardi

Your meticulous update to the documentation configuration brings us one step closer to excellence by streamlining the user experience and guiding our community to focus on what truly matters. Your efforts to craft cleaner, more intuitive navigation will undoubtedly enhance the journey for all who visit our docs. 🚀

We deeply appreciate your dedication and attention to detail—Ultralytics is better because of passionate contributors like you! ❤️

ultralytics / ultralytics