docs: make Customization a subtopic under Configuration (Fixes #1663)
Description
This PR reorganizes the documentation so that Customization appears as a subsection under Configuration, as suggested in issue #1663. The previous navigation structure listed both topics at the same level, which caused confusion because customization options are part of configuration.
What I changed:
- Updated
mkdocs.ymlto nestCustomizationunderConfiguration - Adjusted the heading in
docs/customization.mdto match its new position in the hierarchy
Fixes #1663
Checklist
- [x] I have read the contributing guidelines
Code Changes
N/A — this PR only updates documentation structure.
Documentation Changes
- [x] Updated navigation structure in
mkdocs.yml - [x] Adjusted heading levels in
customization.md - [x] Verified the documentation builds correctly
Expected Behavior
The documentation sidebar should now display:
Configuration
↳ Overview
↳ Customization
This better reflects the intended hierarchy.
Steps to Test This Pull Request
- Run
mkdocs serve - Check the left sidebar to confirm that:
- "Customization" is listed under "Configuration"
- All pages load correctly without broken links
Additional Context
No further changes required.
Codecov Report
:white_check_mark: All modified and coverable lines are covered by tests.
:white_check_mark: Project coverage is 98.68%. Comparing base (120d514) to head (fce8dfe).
:warning: Report is 885 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #1674 +/- ##
==========================================
+ Coverage 97.33% 98.68% +1.34%
==========================================
Files 42 60 +18
Lines 2104 2656 +552
==========================================
+ Hits 2048 2621 +573
+ Misses 56 35 -21
| Flag | Coverage Δ | |
|---|---|---|
| unittests | 98.68% <ø> (+1.34%) |
:arrow_up: |
Flags with carried forward coverage won't be shown. Click here to find out more.
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
Actually I already created #1657 which splits configuration.md into pages.
Closing since the issue is already resolved.