Skip to content

Added the Table of Contents#15218

Merged
felicitymay merged 14 commits intogithub:mainfrom
wonntann:patch-2
Feb 11, 2022
Merged

Added the Table of Contents#15218
felicitymay merged 14 commits intogithub:mainfrom
wonntann:patch-2

Conversation

@wonntann
Copy link
Contributor

@wonntann wonntann commented Feb 7, 2022

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:

  • I have reviewed my changes in staging (look for "Automatically generated comment" and click Modified to view your latest changes).
  • For content changes, I have completed the self-review checklist.

Writer impact (This section is for GitHub staff members only):

  • This pull request impacts the contribution experience
    • I have added the 'writer impact' label
    • I have added a description and/or a video demo of the changes below (e.g. a "before and after video")

Linked to the github blog post for the png image to visualize the generated table of contents from the headings
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Feb 7, 2022
@wonntann wonntann mentioned this pull request Feb 7, 2022
5 tasks
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 7, 2022 19:53 Inactive
@ramyaparimi ramyaparimi added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Feb 8, 2022
@ramyaparimi
Copy link
Contributor

@wonntann
Thanks so much for opening a PR! I'll get this triaged for review ⚡

Copy link
Contributor

@felicitymay felicitymay left a comment

Choose a reason for hiding this comment

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

@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 🎉

…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 9, 2022 10:59 Inactive
image displaying the table of contents featuring the headings in the respective document
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 9, 2022 19:08 Inactive
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 9, 2022 19:15 Inactive
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 9, 2022 19:22 Inactive
…ting-and-formatting-on-github/basic-writing-and-formatting-syntax.md
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 9, 2022 22:52 Inactive
@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 10, 2022 17:29 Inactive
@wonntann
Copy link
Contributor Author

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?

@wonntann
Copy link
Contributor Author

image
Here is the updated image.

@felicitymay
Copy link
Contributor

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.

  • Theoretically, you could do this in the UI by going to the https://github.com/github/docs/pull/15218/files page, clicking on the ... in the top right corner of the image file, and selecting Delete. You ought then to be able to add the image again.
  • If you have your fork of the repository locally, and you're still on this patch-2 branch. You can simply overwrite the old image with the new image in your file system. You should then find this shows up as a changed file. Then you could staging and commit the file.

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.

@github-actions github-actions bot temporarily deployed to docs-15218--patch-2 February 10, 2022 19:26 Inactive
@wonntann
Copy link
Contributor Author

Thanks @wonntann - happy to give a try.

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

@felicitymay
Copy link
Contributor

felicitymay commented Feb 10, 2022

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.

  1. Click on your branch name at the top of the page wonntann:patch-2. This should take you to: https://github.com/wonntann/docs/tree/patch-2.
  2. Navigate to the folder that contains the image and click the image (I think this might be: https://github.com/wonntann/docs/blob/patch-2/assets/images/help/repository/headers_toc.png).
  3. At the top right of the header for the file, you should see a bin icon. Click this to delete the current image.
  4. Commit that change.
  5. On the next page, you should find yourself in the /assets/images/help/repository/ folder with an Add file button. You ought to be able to add the cropped image to the folder and commit this change.

If this doesn't work, I'll find an alternative solution. Thanks for your patience 💖

@wonntann
Copy link
Contributor Author

If this doesn't work, I'll find an alternative solution. Thanks for your patience sparkling_heart
Thank you so much @felicitymay
Please let me know if there needs to be any changes on my end. Have a great day!

@felicitymay
Copy link
Contributor

Please let me know if there needs to be any changes on my end. Have a great day!

@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.

@felicitymay
Copy link
Contributor

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 💖

@felicitymay felicitymay merged commit aeef907 into github:main Feb 11, 2022
@github-actions
Copy link
Contributor

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants