Add SKILL.md for creating resource docs#1546
Open
SteveL-MSFT wants to merge 2 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new GitHub Skills prompt to guide agents/contributors in authoring DSC resource reference documentation that matches the established docs/reference/resources/ conventions.
Changes:
- Introduces
.github/skills/create-resource-doc/SKILL.mdwith a prescribed structure forindex.mdresource docs. - Documents conventions for example markdown/config files, link reference definitions, and schema/exit-code sourcing.
- Adds an authoring checklist and information-gathering table to reduce fabricated/incorrect docs.
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
Add a SKILL.md for authoring docs for resources