Skip to content
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

[chore] polish dev MD docs formatting #17951

Open
2 of 15 tasks
Jay-o-Way opened this issue Apr 28, 2022 · 9 comments
Open
2 of 15 tasks

[chore] polish dev MD docs formatting #17951

Jay-o-Way opened this issue Apr 28, 2022 · 9 comments
Labels
Idea-Enhancement New feature or request on an existing product Issue-Docs Documentation issue that needs to be improved Needs-Team-Response An issue author responded so the team needs to follow up

Comments

@Jay-o-Way
Copy link
Collaborator

Jay-o-Way commented Apr 28, 2022

Provide a description of requested docs changes

Low priority.

Writing guidelines state:

Specific file attention points:

In akaLinks.md file:

powerToysCannotRemapKeys https://docs.microsoft.com/windows/powertoys/keyboard-manager#keys-that-cannot-be-remapped
→ page exists, header does not

powertoys-docs https://docs.microsoft.com/windows/powertoys/?WT.mc_id=twitter-0000-docsmsft
→ why the "?" part

https://raw.githubusercontent.com/wiki/microsoft/PowerToys/images/overview/KBM_small.png
→ really old

powerToysRequestFeature https://github.com/microsoft/PowerToys/issues/new?assignees=&labels=&template=feature_request.md&title=
→ link opens general "new/choose" page

OLD
  • modules/launcher/plugins/registry.md still mentions "Microsoft.CodeAnalysis.FxCopAnalyzers" https://github.com/dotnet/roslyn-analyzers
  • modules/launcher/project_structure.md has broken links: href=/src/modules/launcher/Wox.Core/Plugin
@Jay-o-Way Jay-o-Way added Issue-Docs Documentation issue that needs to be improved Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams labels Apr 28, 2022
@Jay-o-Way Jay-o-Way self-assigned this Apr 28, 2022
@Jay-o-Way Jay-o-Way added the Idea-Enhancement New feature or request on an existing product label Apr 28, 2022
@crutkas
Copy link
Member

crutkas commented Apr 29, 2022

@Jay-o-Way
Copy link
Collaborator Author

Jay-o-Way commented Apr 29, 2022

  • context here is critical. User docs vs dev docs are different beasts.

Okay. Does that mean that some of the guidie/rules should be different then? Which ones are the first? Is there a (VS Code) plugin that is specially for dev docs? CC @mattwojo

edit: that must be https://docs.microsoft.com/en-us/style-guide/developer-content/formatting-developer-text-elements

Any advice for the last two points? ("Powerlauncher" and broken links)

@Jay-o-Way Jay-o-Way changed the title [chore] polish docs in background [chore] polish dev docs in background Apr 29, 2022
@crutkas
Copy link
Member

crutkas commented May 4, 2022

what pages are they broken? I need more context

for dev docs, launcher / PT Run are one and the same. Launcher was what we called it almost until it shipped. The folder is even called launcher :) Something like this i'd call out early on if you feel is needed and just move forward. Dev Docs are for people working on the guts, references like this will happen all the time. Like knowing KBM is keyboard manager.

@Jay-o-Way

This comment was marked as outdated.

@Jay-o-Way
Copy link
Collaborator Author

  • scoobe should be deleted as it should be in the wiki

Maybe so, but all of the WIKI looks pretty dead too... 💀

@Jay-o-Way Jay-o-Way added Needs-Community Feedback We need additional help with how something should act / look Needs-Team-Response An issue author responded so the team needs to follow up and removed Needs-Community Feedback We need additional help with how something should act / look Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams labels May 13, 2022
@Jay-o-Way Jay-o-Way changed the title [chore] polish dev docs in background [chore] polish dev MD docs formatting May 25, 2022
@Jay-o-Way Jay-o-Way added the Status-In progress This issue or work-item is under development label Jul 15, 2022
@Jay-o-Way Jay-o-Way removed the Status-In progress This issue or work-item is under development label Aug 8, 2022
@Jay-o-Way Jay-o-Way removed their assignment Aug 8, 2022
@crutkas crutkas removed the Needs-Team-Response An issue author responded so the team needs to follow up label Feb 14, 2023
@crutkas
Copy link
Member

crutkas commented Feb 14, 2023

what is left here to wrap this up

@crutkas
Copy link
Member

crutkas commented Feb 14, 2023

/needinfo

@microsoft-github-policy-service microsoft-github-policy-service bot added the Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something label Feb 14, 2023
@Jay-o-Way
Copy link
Collaborator Author

Jay-o-Way commented Feb 16, 2023

Quite a few things. I've updated the main comment. PTAL.
If you want me to get on with this, give me a reminder.

@microsoft-github-policy-service microsoft-github-policy-service bot added Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams Needs-Team-Response An issue author responded so the team needs to follow up and removed Needs-Author-Feedback The original author of the issue/PR needs to come back and respond to something labels Feb 16, 2023
@Jay-o-Way Jay-o-Way removed the Needs-Triage For issues raised to be triaged and prioritized by internal Microsoft teams label Feb 28, 2023
Aaron-Junker added a commit that referenced this issue Mar 19, 2023

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
stefansjfw added a commit that referenced this issue Mar 24, 2023
* first push (associated issues: #17951 #761)

* More docs

* Fix spelling

* More docs

* Fix spelling

* Push

* Fix link

* Fix spelling

* Update bug-report-tool.md

* Update verification-scripts.md

* Update doc/devdocs/tools/bug-report-tool.md

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>

* Update doc/devdocs/tools/bug-report-tool.md

* Update doc/devdocs/tools/styles-report-tool.md

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>

* Update doc/devdocs/tools/build-tools.md

* Update doc/devdocs/tools/clean-up-tool.md

---------

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
Co-authored-by: Stefan Markovic <57057282+stefansjfw@users.noreply.github.com>
BLM16 pushed a commit to BLM16/PowerToys that referenced this issue Jun 22, 2023
* first push (associated issues: microsoft#17951 microsoft#761)

* More docs

* Fix spelling

* More docs

* Fix spelling

* Push

* Fix link

* Fix spelling

* Update bug-report-tool.md

* Update verification-scripts.md

* Update doc/devdocs/tools/bug-report-tool.md

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>

* Update doc/devdocs/tools/bug-report-tool.md

* Update doc/devdocs/tools/styles-report-tool.md

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>

* Update doc/devdocs/tools/build-tools.md

* Update doc/devdocs/tools/clean-up-tool.md

---------

Co-authored-by: Heiko <61519853+htcfreek@users.noreply.github.com>
Co-authored-by: Stefan Markovic <57057282+stefansjfw@users.noreply.github.com>
@Jay-o-Way
Copy link
Collaborator Author

@crutkas I see that it's possible to use "subdirectories" in aka links. What do you think of using that for PowerToys links?

For example I saw: https://aka.ms/wct/releasenotes/8.0

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Idea-Enhancement New feature or request on an existing product Issue-Docs Documentation issue that needs to be improved Needs-Team-Response An issue author responded so the team needs to follow up
Projects
Status: No status
Development

No branches or pull requests

2 participants