Skip to content

CmdPal doc fixes and small tweaks #5483

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

Merged
merged 2 commits into from
Jun 12, 2025
Merged

Conversation

chatasweetie
Copy link
Contributor

  • add reload screenshot
  • add link to toolkit
  • correct updating list of commands code
  • add <> to extentionname in samples for better readability and accessabilty
  • add Notes about diffs in code for using prior section development
  • correct loading spinner sample code

…commands code, add <> to extentionname in samples, add Notes about diffs in code for using prior secion development, correct loading spinner sample code
Copy link
Contributor

@chatasweetie : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 997a706:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/powertoys/command-palette/creating-an-extension.md ⚠️Warning Details
hub/powertoys/command-palette/update-a-list-of-commands.md ⚠️Warning Details
hub/images/command-palette/reload.png ✅Succeeded
hub/powertoys/command-palette/add-top-level-commands-to-your-extension.md ✅Succeeded
hub/powertoys/command-palette/adding-commands.md ✅Succeeded
hub/powertoys/command-palette/command-results.md ✅Succeeded
hub/powertoys/command-palette/using-markdown-content.md ✅Succeeded

hub/powertoys/command-palette/creating-an-extension.md

  • Line 60, Column 13: [Warning: disallowed-html-tag - See documentation] HTML tag 'ExtensionName' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder.
  • Line 77, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/command-palette/reload.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

hub/powertoys/command-palette/update-a-list-of-commands.md

  • Line 18, Column 253: [Warning: hard-coded-locale - See documentation] Link 'https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/microsoft-commandpalette-extensions-toolkit' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites.
  • Line 18, Column 253: [Suggestion: docs-link-absolute - See documentation] Absolute link 'https://learn.microsoft.com/en-us/windows/powertoys/command-palette/microsoft-commandpalette-extensions-toolkit/microsoft-commandpalette-extensions-toolkit' will be broken in isolated environments. Replace with a relative link.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

@alvinashcraft alvinashcraft left a comment

Choose a reason for hiding this comment

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

Some suggestions and a question inline. Thanks for this PR!

Copy link
Contributor

Learn Build status updates of commit 39c9bc2:

💡 Validation status: suggestions

File Status Preview URL Details
hub/powertoys/command-palette/creating-an-extension.md 💡Suggestion Details
hub/images/command-palette/reload.png ✅Succeeded
hub/powertoys/command-palette/add-top-level-commands-to-your-extension.md ✅Succeeded
hub/powertoys/command-palette/adding-commands.md ✅Succeeded
hub/powertoys/command-palette/command-results.md ✅Succeeded
hub/powertoys/command-palette/update-a-list-of-commands.md ✅Succeeded
hub/powertoys/command-palette/using-markdown-content.md ✅Succeeded

hub/powertoys/command-palette/creating-an-extension.md

  • Line 77, Column 1: [Suggestion: image-structure-incorrect - See documentation] Invalid image path 'images/command-palette/reload.png'. Images should be placed in a /media folder adjacent to the file where they are rendered, and in a subfolder matching the article name.

For more details, please refer to the build report.

Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Image File This PR added or updated an image file(s).

Copy link
Contributor

@alvinashcraft alvinashcraft left a comment

Choose a reason for hiding this comment

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

This looks good, @chatasweetie. Thanks again! Is there anything in here that needs to wait for the upcoming PowerToys release, or can I merge this now?

@chatasweetie
Copy link
Contributor Author

none of this needs to wait, it's all on current external content,

@alvinashcraft alvinashcraft merged commit fe6e9a2 into MicrosoftDocs:docs Jun 12, 2025
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants