-
Notifications
You must be signed in to change notification settings - Fork 32
[Nav] Move contribution sections to bottom of nav #2061
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
[Nav] Move contribution sections to bottom of nav #2061
Conversation
florent-leborgne
left a comment
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.
👍
|
CI is failing. Asked a friend about this and they said: Issue SummaryProblem: The CI test Root cause: The test filtering code in ConfigurationFileProvider.cs:164-179 appends test-only docs-builder content (indented with 6 spaces for Reference section children) to the end of the navigation file. When the file ends with top-level sections (EXTEND/CONTRIBUTE at 2-space indentation), this creates invalid YAML structure. Current behavior:
Recommended solutionsOption 1: Add Marker Comment in navigation.ymlAdd a comment in navigation.yml that indicates where the Reference section ends, so the filtering code can insert docs-builder content before the EXTEND section: # Glossary
- toc: docs-content://reference/glossary
path_prefix: reference/glossary
# END REFERENCE SECTION - test docs-builder content will be inserted above this line
##########
# EXTEND #
##########Then modify the filtering code to detect this marker and insert before it. Option 2: Update filtering logicModify ConfigurationFileProvider.cs:125-179 to detect the EXTEND section header and insert docs-builder content before it, rather than blindly appending at EOF. This makes the code resilient to navigation structure changes. Option 3: Change docs-builder test content indentationChange the docs-builder injection to use 2-space indentation (making it a top-level section) instead of 6-space. Since this is test-only content, semantic correctness matters less than valid YAML. |
|
@reakaleek Hmmm, CI's still failing... |
|
🚀 |
We had a spirited discussion about this in Slack and this short term reshuffle makes more sense to put the "not docs about the product" docs at bottom
Full build nav looks like this:
