-
Notifications
You must be signed in to change notification settings - Fork 58.5k
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
Expand Section Links documentation and add a section for Custom Anchors #33531
base: main
Are you sure you want to change the base?
Expand Section Links documentation and add a section for Custom Anchors #33531
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
Automatically generated comment ℹ️This comment is automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
fpt: Free, Pro, Team |
ff2e392
to
7a240a7
Compare
Re-based on master. If checks pass and it looks good to me in the preview environment, I'll be ready to submit this for review. |
7a240a7
to
ff2e392
Compare
Re-pushed from my local environment to sign the commits. |
ff2e392
to
04a9003
Compare
Once more, with feeling... |
Those linter errors for broken links don't have anything to do with my changes, as they're in completely unrelated files. Linter does not throw any errors when run locally as Here are the previews for the modified and added documentation: This is ready for review. |
Hm. I should probably make the section link I added to the Stand by... |
* Additional examples added. * Modified language to align more closely with the style guide. * More specific details about auto-naming rules.
04a9003
to
49d4159
Compare
Links are now relative. Let's see how this goes... |
Bah. Checks pass, but I accidentally mixed up a link. Correction coming up. |
Change made and it now looks and behaves as intended. I also made the following comment in the associated issue, #33530, but I'll paste/quote it here, as well, for visibility:
|
@dodexahedron Thanks so much for opening a PR! I'll get this triaged for review ✨ |
My pleasure. Any requests/thoughts/ideas/rude commentary, just let me know! |
Why:
The information on section links and how they work doesn't really explain how to use them or how they are made.
Also, custom anchors can be used (and are, in fact, quite common in a lot of Microsoft Learn documents, for precedent), so I added a section for them, as well, in a separate commit.
Closes: #33530
What's being changed (if available, include any code snippets, screenshots, or gifs):
As described in #33530, I have expanded and enhanced the Section links reusable, detailing behavior and usage, as well as added a small section detailing behavior and usage of custom anchor tags.
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).
data
directory.For content changes, I have completed the self-review checklist.