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

Delete manual Markdown ToCs #6760

Merged
merged 1 commit into from
Aug 16, 2021
Merged

Delete manual Markdown ToCs #6760

merged 1 commit into from
Aug 16, 2021

Conversation

rainersigwald
Copy link
Member

GitHub now generates navigation options in Markdown files, so no need to have them here manually.

GitHub now [generates navigation options][1] in Markdown files, so no need to have them here manually.

[1]: https://github.blog/changelog/2021-04-13-table-of-contents-support-in-markdown-files/
Copy link
Member

@Forgind Forgind left a comment

Choose a reason for hiding this comment

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

I'm a bit split because I like getting rid of unnecessary things, but it's really easy to see this table of contents, whereas the built-in version is hard to notice if you don't already know about it. Probably fine, though.

@Forgind Forgind added the merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now. label Aug 16, 2021
Copy link
Member

@benvillalobos benvillalobos left a comment

Choose a reason for hiding this comment

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

I'm a bit split because I like getting rid of unnecessary things, but it's really easy to see this table of contents, whereas the built-in version is hard to notice if you don't already know about it. Probably fine, though.

I had the same thought almost verbatim.

@rainersigwald
Copy link
Member Author

I think they should be deleted because

  1. they have to be manually maintained
  2. They take up a bunch of vertical space meaning you're likely to need to scroll to see any useful content.

@Forgind Forgind merged commit b92bd70 into dotnet:main Aug 16, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge-when-branch-open PRs that are approved, except that there is a problem that means we are not merging stuff right now.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants