Stream: docs

Topic: TOC nesting


view this post on Zulip Philip Durbin πŸš€ (Sep 16 2024 at 18:39):

A few times it's been stated that we might want to limit the amount of nesting for the index page of each guide.

view this post on Zulip Philip Durbin πŸš€ (Sep 16 2024 at 18:40):

Here's how the User Guide looks, for example, as of 6.3: https://guides.dataverse.org/en/6.3/user/

view this post on Zulip Philip Durbin πŸš€ (Sep 16 2024 at 18:40):

I just created https://github.com/IQSS/dataverse/pull/10847 which limits the nesting to two levels: https://dataverse-guide--10847.org.readthedocs.build/en/10847/user/index.html

view this post on Zulip Dimitri Szabo (Sep 30 2024 at 15:58):

I does really looks cleaner and clearer :smile:

view this post on Zulip Philip Durbin πŸš€ (Jan 17 2025 at 16:08):

As the #docs working group discovered today those preview links from that old pull request above don't work anymore. :doh:

view this post on Zulip Philip Durbin πŸš€ (Jan 17 2025 at 16:08):

But don't worry, I created a fresh PR at https://github.com/IQSS/dataverse/pull/11166 and you can preview it at https://dataverse-guide--11166.org.readthedocs.build/en/11166/

view this post on Zulip Philip Durbin πŸš€ (Jan 17 2025 at 16:10):

@Vaida PlankytΔ— @Dieuwertje Bloemen @Oliver Bertuch (and others) please take a look. If you like it you can leave a pull request and click "Approve".

(If or when Oliver does this, it will move the pull request from "ready for review" to "ready for QA" automatically because he's part of the core team but anyone is welcome to leave a review!)

If something is off, please let me know here or in the PR. Thanks!

view this post on Zulip Philip Durbin πŸš€ (Jan 30 2025 at 15:21):

@Dieuwertje Bloemen thanks for approving the PR!

view this post on Zulip Philip Durbin πŸš€ (Jan 30 2025 at 15:21):

We still need a core team member to approve it but I appreciate the show of support!

view this post on Zulip Philip Durbin πŸš€ (Feb 11 2025 at 18:46):

#11166 has been merged! You can see the change at https://preview.guides.gdcc.io/en/develop/user/index.html now, for example.

view this post on Zulip Vaida PlankytΔ— 🎨 (Feb 21 2025 at 12:36):

awesome! :tada:


Last updated: Nov 01 2025 at 14:11 UTC