limit table of contents in guides to depth of 2 #11166
Open
+14
−2
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What this PR does / why we need it:
As discussed in a couple meetings with the Documentation Working Group, the amount of information you see when clicking on any given guide is overwhelming. Here's an example from the User Guide:
This pull requests limits the depth of the table of contents to two levels. Here's the User Guide as an example:
Which issue(s) this PR closes:
None
Special notes for your reviewer:
The majority of our guides are the old school .rst variety and look the same. Two newer guides are use .md and look a bit different:
Suggestions on how to test this:
Make sure the depth is 2.
Does this PR introduce a user interface change? If mockups are available, please link/include them here:
No but there are screenshots above.
Is there a release notes update needed for this change?:
Yes, included.
Additional documentation:
You can preview the change at https://dataverse-guide--11166.org.readthedocs.build/en/11166/