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

Separate TOC from the navigation #13161

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

dhruvmanila
Copy link
Member

@dhruvmanila dhruvmanila commented Aug 30, 2024

Summary

This PR does the following:

  1. Separate table of contents from the navigation
  2. Group certain pages into a single header (like references for settings, rules, etc.)
  3. Remove the "Ruff" header in the navigation similar to uv

For (2), the URL doesn't change. For example, even though the settings page is under "References", the url is still "/ruff/settings" instead of "/ruff/references/settings". Ideally, we'd want to move towards the latter URL but it will require creating redirects. I think we could either (a) keep the changes as it is or (b) postpone (2) to be done when we're restructuring the docs and / or adding versioned documentation. @zanieb would love to hear your thoughts here.

Test Plan

mkdocs serve --strict -f mkdocs.insiders.yml, no warnings on generating the documentation site and validate the pages.

@dhruvmanila dhruvmanila added the documentation Improvements or additions to documentation label Aug 30, 2024
Copy link
Contributor

github-actions bot commented Aug 30, 2024

ruff-ecosystem results

Linter (stable)

✅ ecosystem check detected no linter changes.

Linter (preview)

✅ ecosystem check detected no linter changes.

Formatter (stable)

✅ ecosystem check detected no format changes.

Formatter (preview)

✅ ecosystem check detected no format changes.

@dhruvmanila dhruvmanila force-pushed the dhruv/restructure-docs branch from 460a998 to ac013db Compare September 5, 2024 10:25
@dhruvmanila dhruvmanila force-pushed the dhruv/restructure-docs branch from ac013db to 1dc0a52 Compare September 5, 2024 10:39
@dhruvmanila dhruvmanila marked this pull request as ready for review September 5, 2024 10:46
@dhruvmanila dhruvmanila requested a review from zanieb September 5, 2024 10:46
@zanieb
Copy link
Member

zanieb commented Dec 10, 2024

I'm supportive of any changes for consistency between the Ruff and uv docs. Especially w.r.t styling since it doesn't require a lot of work.

Copy link
Member

@zanieb zanieb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be tackling the reorganization of the content separately?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants