Skip to content
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

limit table of contents in guides to depth of 2 #11166

Open
wants to merge 3 commits into
base: develop
Choose a base branch
from

Conversation

pdurbin
Copy link
Member

@pdurbin pdurbin commented Jan 17, 2025

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:

Screenshot 2025-01-17 at 10 31 05 AM

This pull requests limits the depth of the table of contents to two levels. Here's the User Guide as an example:

Screenshot 2025-01-17 at 10 58 00 AM

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:

  • The QA Guide shows "Contents:" in regular font instead of bold. I tried a bit to fix this but it was non-obvious so I gave up. Perhaps someday we'll move all guides from .rst to .md and they will all be consistent.
  • The Contributor Guide has a box around the contents. This is because the most of the content is on a single page. This was done be design when then guide was created (see Add a Contributor Guide #10532).

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/

@pdurbin pdurbin added the Size: 0.5 A percentage of a sprint. 0.35 hours label Jan 17, 2025
@pdurbin pdurbin mentioned this pull request Jan 17, 2025
@pdurbin pdurbin added the FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) label Jan 17, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
FY25 Sprint 15 FY25 Sprint 15 (2025-01-15 - 2025-01-29) Size: 0.5 A percentage of a sprint. 0.35 hours
Projects
Status: Ready for Review ⏩
Development

Successfully merging this pull request may close these issues.

1 participant