docs: make Table of Contents a real heading so its anchor works - #12439
Closed
simpleqt wants to merge 2 commits into
Closed
docs: make Table of Contents a real heading so its anchor works#12439simpleqt wants to merge 2 commits into
simpleqt wants to merge 2 commits into
Conversation
The intro links to #table-of-contents but the ToC title was bold text (**Table of Contents**), which GitHub does not anchor; use an h2.
|
@simpleqt is attempting to deploy a commit to the deepset Team on Vercel. A member of the Team first needs to authorize it. |
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
- Fixes a dead intra-document link in
CONTRIBUTING.mdby making “Table of Contents” an actual Markdown heading so GitHub generates the expected#table-of-contentsanchor.
Changes:
- Promote “Table of Contents” from bold text to an
h2(##) heading. - Preserve the existing
[#table-of-contents](#table-of-contents)link target without requiring any other reference updates.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
This was referenced Aug 24, 2026
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
|
Thanks, but it's OK like it is. |
Contributor
Author
|
Understood, thanks for taking a look! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The intro of
CONTRIBUTING.mdlinks to#table-of-contents, but the ToC title was bold text (**Table of Contents**), which GitHub does not anchor — the link was dead. Promoting it to anh2makes the existing link work with no other changes.