Add documentation for WinGet studio #154
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Created a new document for migrating WinGet Configuration from 0.2.0 to Microsoft DSC 3.x format, detailing step-by-step instructions and examples. - Added an overview document for WinGet Studio, explaining its purpose, capabilities, and when to use it. - Introduced CLI reference documentation for WinGet Studio, including commands for managing DSC resources and settings. - Implemented detailed documentation for the `dsc` command, covering operations like get, set, test, and export for DSC resources. - Added a `settings` command reference to manage WinGet Studio settings via the CLI. - Created a comprehensive reference for the Settings resource, including supported operations, properties, and usage examples. - Established a new index for reference documentation, linking CLI commands and DSC resources for easier navigation.
This was referenced Nov 4, 2025
denelon
reviewed
Nov 4, 2025
denelon
approved these changes
Nov 4, 2025
Collaborator
|
@AmelBawa-msft I'd like you to take a look at this PR before merging. |
AmelBawa-msft
approved these changes
Nov 5, 2025
Contributor
AmelBawa-msft
left a comment
AmelBawa-msft
left a comment
There was a problem hiding this comment.
LGTM! Thank you for the detailed docs ✨🔥
Since we are still in development phase, things are changing fast so I will update in follow up PRs accordingly 😊
3 tasks
AmelBawa-msft
approved these changes
Nov 7, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📖 Description
This PR adds documentation for WinGet Studio, covering concepts, how-to guides, CLI reference, and migration workflows. The documentation follows markdownlint standards and uses consistent formatting with link reference definitions.
Documentation Added
Core Documentation:
docs/overview.md- Overview of WinGet Studio features, architecture, and capabilitiesdocs/glossary.md- Comprehensive terminology guide distinguishing PowerShell DSC v2 from Microsoft DSC v3docs/changelog.md- Release notes structure (currently contains v0.100.302.0 heading)Concepts:
docs/concepts/configuration-versions.md- Detailed comparison of 0.2.0 vs Microsoft DSC 3.x formatsdocs/concepts/understanding-resources.md- Resource types, PowerShell Gallery discovery, and catalog structureHow-To Guides:
docs/how-to/customize-exported-configuration.md- Guide for customizing configuration parameters, dependencies, and metadatadocs/how-to/migrate-configuration-to-dsc3.md- Step-by-step migration guide from 0.2.0 to Microsoft DSC 3.x with complete examplesGetting Started:
docs/get-started/index.md- Quick start guide with prerequisites, GUI/CLI workflows, and validation stepsCLI Reference:
docs/reference/index.md- Reference documentation landing pagedocs/reference/cli/index.md- CLI overviewdocs/reference/cli/dsc.md- DSC command reference (get, set, test, validate)docs/reference/cli/settings.md- Settings command referencedocs/reference/resources/settings.md- Settings resource documentationDocumentation Updates
README.md:
CONTRIBUTING.md:
Test Documentation:
src/WinGetStudio.Tests.MSTest/README.mdKey Features
🔗 References and Related Issues
🔍 How to Test
docs/directorymarkdown-link-check docs✅ Checklist