Added the Table of Contents#15218
Conversation
Linked to the github blog post for the png image to visualize the generated table of contents from the headings
|
@wonntann |
felicitymay
left a comment
There was a problem hiding this comment.
@wonntann - thank you so much for persevering and creating a new PR to replace #13297 💖
This looks good. I've made one suggestion to bring the text more into line with our current guidelines which I'll merge, and a second suggestion to fix the image.
When you've added the suggested image, we should be ready to merge this PR and publish your changes 🎉
...getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
Outdated
Show resolved
Hide resolved
...getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
Outdated
Show resolved
Hide resolved
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
image displaying the table of contents featuring the headings in the respective document
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
...getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
Outdated
Show resolved
Hide resolved
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
...getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
Outdated
Show resolved
Hide resolved
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
|
Sounds great. I have made the edits for the image. Do you mind guiding me on how to update the image without having to do a different pull request? |
Thanks @wonntann - happy to give a try.
If none of this makes any sense, perhaps you can let me know how you added the original image. That might help me work out what method would work best for updating the image. |
Thanks for the walk through, I am not able to do either of those options, since I didn't work on it locally nor can I clone it at the moment. I original added the image via the "Make a contribution" link on the github docs page for this topic at https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax |
|
Hi @wonntann - if you have time, I think I now have good instructions for you - now that I know how you created the PR and did some testing.
If this doesn't work, I'll find an alternative solution. Thanks for your patience 💖 |
Updating the headers_toc.png image as per github#15218 (comment)
|
...getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax.md
Outdated
Show resolved
Hide resolved
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@wonntann - thanks for persevering and fixing the image 💖 I think this PR is ready to merge, but I'd like to check the preview first, just to confirm that all is well. Unfortunately, there seems to be a problem with the preview. I'm checking with our engineers about this and hope to be able to merge this PR shortly. After that, your changes will be live within around 24 hours. |
|
Thanks to our wonderful engineers the previews are now working correctly and we can merge this PR 🚀 🥳 It may take up to 24 hours before you see your change in the live docs. Thanks for your contribution @wonntann 💖 |
|
Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues ⚡ |

Linked to the github blog post for the png image to visualize the generated table of contents from the headings
Why:
Closes [issue link]
What's being changed:
Check off the following:
Writer impact (This section is for GitHub staff members only):