Makes headings consistent across PowerToys documentation #4820
Conversation
|
@NathanD-GDS : Thanks for your contribution! The author(s) have been notified to review your proposed change. |
prmerger-automator
bot
added
Change sent to author
dev-environment/prod
powertoys/tech
|
Learn Build status updates of commit 70992a1:
|
|
Learn Build status updates of commit bb93319:
|
|
Learn Build status updates of commit 8b4c452:
|
Removes as `abbr` HTML tag because the PR was giving warnings about it.
PRMerger Results
|
|
Thanks for the submission, @NathanD-GDS. I'll have to discuss this with the team on our call this week. I try to avoid changing H1s and H2s unless they're incorrect because folks out there may have bookmarked or shared links that jump to those specific sections. We may have cross-links in the docs that also do this. |
That makes sense, @alvinashcraft . I hadn't considered the possibility of bookmarks. I think I did a cursory look for cross-links but I wasn't exhaustive. Understand if this PR is a no-go. |
|
@alvinashcraft , @NathanD-GDS |
|
[like] Alvin Ashcraft reacted to your message:
…________________________________
From: Heiko ***@***.***>
Sent: Sunday, January 28, 2024 7:07:42 PM
To: MicrosoftDocs/windows-dev-docs ***@***.***>
Cc: Alvin Ashcraft ***@***.***>; Mention ***@***.***>
Subject: Re: [MicrosoftDocs/windows-dev-docs] Makes headings consistent across PowerToys documentation (PR #4820)
@alvinashcraft<https://github.com/alvinashcraft> , @NathanD-GDS<https://github.com/NathanD-GDS>
For the policy page there is another reason to not change them: The header of the policies is the policy name.
—
Reply to this email directly, view it on GitHub<#4820 (comment)>, or unsubscribe<https://github.com/notifications/unsubscribe-auth/AAAR24CX5KRLCSHVNB7FPU3YQ2OX5AVCNFSM6AAAAABBY44FNGVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSMJTGY4TENRXHE>.
You are receiving this because you were mentioned.Message ID: ***@***.***>
|
|
Good point, @htcfreek. @NathanD-GDS I don't want to discard the PR because I think there are some good changes here. Let's wait until several other PRs merge with the next release in a few days and then do the following:
Let me know what you think. I know it adds a bit of work to implement the last suggestion. |
|
I too appreciate the effort. Few valid comments up above here. After a while, there's no shame in starting over with a fresh branch. |
|
looking at aka links that i control, here are the two i spotted with anchors. These would need to have backup anchors https://learn.microsoft.com/windows/powertoys/keyboard-manager#keys-that-cannot-be-remapped |
The headings across the PowerToys documentation are very inconsistent.
This PR:
Use PowerToys RunbecomesUsing PowerToys Run)Plugin managerbecomesUsing plugins for PowerToys Run)How to usebecomesUsing Quick Accent)utilitysuffix to H1sLimitationsbecomesLimitations of Color PickerSome generic headings, such as
Settings, have been left alone.If it turns out that another verb format is better for headings, this PR should make it easier to change as most headings now follow a similar structure.