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

Fix double-nesting of cutting tutorials & how-tos in table of contents #377

Merged
merged 1 commit into from
Aug 20, 2023

Conversation

garrison
Copy link
Member

I noticed that the cutting tutorials & how-tos are double nested in the table of contents. This currently happens because each header appears redundantly, in README.rst and index.rst. This PR fixes the redundancy by removing headers from index.rst. They are worth keeping in README.rst, because there they will be shown to users who browse to those directories on github.com.

I built the docs locally, and they look great with this change.

specifically, the tutorials & how-to's
@garrison garrison added the documentation Improvements or additions to documentation label Aug 20, 2023
@garrison garrison requested a review from caleb-johnson August 20, 2023 00:40
@garrison garrison added the stable backport potential Suitable to be backported to most recent stable branch by Mergify label Aug 20, 2023
Copy link
Collaborator

@caleb-johnson caleb-johnson left a comment

Choose a reason for hiding this comment

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

nice catch, thanks

@garrison garrison merged commit 9cc17ed into main Aug 20, 2023
@garrison garrison deleted the fix-double-nested-cutting-docs branch August 20, 2023 18:00
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 stable backport potential Suitable to be backported to most recent stable branch by Mergify
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants