[DevDocs] More content and restructure #40165
Conversation
Add peek to the Monaco usage
Add release checklist for registry preview
Add checklist link for environment variables
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
There was a problem hiding this comment.
check-spelling found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.
|
|
||
| - Context menu handlers for Windows 11 use sparse MSIX packages | ||
| - Previous attempts to create full MSIX installers were abandoned | ||
| - Command Palette will use MSIX when merged into PowerToys |
|
|
||
| - MSIX packages for extensions (like context menus) are included in the PowerToys installer | ||
| - The MSIX files are built as part of the PowerToys build process | ||
| - MSIX files are saved directly into the root folder with base application files |
|
Nice improvement! Really useful for the community 🔥 |
There was a problem hiding this comment.
Pull Request Overview
This PR significantly reworks and expands the PowerToys developer documentation by adding many new pages and reorganizing the content for improved clarity and structure. Key changes include the addition of new detailed guides for tools and modules (e.g. Fuzzing Testing, Debugging Tools, various module documentations), the removal of obsolete documentation files (such as the old settingsv2 readme and runner documents), and updates to the overall index and navigation of the devdocs.
Reviewed Changes
Copilot reviewed 57 out of 99 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| doc/devdocs/tools/readme.md | Removed obsolete tool entries to reflect current available tools. |
| doc/devdocs/fuzzingtesting.md | New comprehensive guide on fuzz testing for PowerToys modules. |
| doc/devdocs/modules/* | Many new module documentation pages added/restructured, covering aspects such as integration, architecture, usage, and troubleshooting. |
| doc/devdocs/development/* | Updated documentation on logging, localization, guidelines, and debugging techniques. |
Comments suppressed due to low confidence (2)
doc/devdocs/modules/hostsfileeditor.md:34
- [nitpick] The same file is referenced twice for both the view and the view model sections. Consider clarifying or removing duplicated entries to avoid confusion.
- View: [HostsMainPage.xaml.cs](/src/modules/Hosts/HostsUILib/HostsMainPage.xaml.cs)
doc/devdocs/modules/peek/readme.md:12
- [nitpick] If this placeholder is not intended for a final release, consider updating or removing it once the Peek documentation is complete.
> Documentation is currently under construction
| var g = Graphics.FromImage(bmp); | ||
| g.CopyFromScreen(rect.Left, rect.Top, 0, 0, bmp.Size, CopyPixelOperation.SourceCopy); |
There was a problem hiding this comment.
To avoid potential resource leaks, consider wrapping the Graphics object in a 'using' statement so that it is automatically disposed after use.
| var g = Graphics.FromImage(bmp); | |
| g.CopyFromScreen(rect.Left, rect.Top, 0, 0, bmp.Size, CopyPixelOperation.SourceCopy); | |
| using (var g = Graphics.FromImage(bmp)) | |
| { | |
| g.CopyFromScreen(rect.Left, rect.Top, 0, 0, bmp.Size, CopyPixelOperation.SourceCopy); | |
| } |
Copilot uses AI. Check for mistakes.
Updated ZoomIt docs to add Debug instructions.
Summary of the Pull Request
Accumulated information from internal transition about the modules development, and reworked it to be added in dev docs. Also the dev docs intself was restructured to be more organized. Most of the new pages was verified by transition team. A few pages still waits for verification.
PR Checklist