microsoft / microsoft/PSDocs-vscode
Additional metadata snippets support
Open
Nobody has claimed this yet.
- Dominant language
- PowerShell
- Stars
- 18
- Forks
- 5
- PR merge metrics
- No merged PRs in 30d
Description
PSDocs supports the following metadata - these should be added to the snippet examples.
| Field | Scope | Type | Description |
|---|---|---|---|
name |
Template | string |
Used for markdown page title. |
summary |
Template | string |
Used as a short description for the markdown page. |
description |
Template | string |
Used as a detailed description for the markdown page. |
description |
Parameter | string |
Used as the description for the parameter. |
example |
Parameter | string, boolean, object, or array |
An example use of the parameter. The example is included in the JSON snippet. If an example is not included the default value is used instead. |
ignore |
Parameter | boolean |
When true the parameter is not included in the JSON snippet. |
description |
Output | string |
Used as the description for the output. |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the snippet definitions in the PSDocs-vscode repository and review the existing metadata examples. Add examples for the listed template, parameter, and output fields, then verify that every metadata entry in the issue is represented consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- powershell
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100