Skip to content

Add 'Getting Started' section #837

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.

Sign up for GitHub

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

Open
chris-peterson wants to merge 1 commit into
base: main
Choose a base branch
from
+17 −0
Open

Add 'Getting Started' section #837

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 17 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,17 @@ Install the module from [PSGallery][06].
Install-PSResource -Name Microsoft.PowerShell.PlatyPS
```

## Getting Started

Creating help files with `PlatyPS` is a multi-step process:

1. [**Create new**][09] or [**update existing**][10] Markdown help files
2. [**Edit the Markdown help**][11] to add descriptions and examples
3. [**Test the Markdown help**][12] to ensure the files render correctly
4. [**Convert and publish**][13] the help files

For detailed guidance, see the [PlatyPS documentation on Microsoft Learn][08].

## Layout of this repository

### Branches
Expand Down Expand Up @@ -80,3 +91,9 @@ To build the source code, run the following command in the root of the repositor
[05]: https://wikipedia.org/wiki/Microsoft_Assistance_Markup_Language
[06]: https://www.powershellgallery.com/packages/Microsoft.PowerShell.PlatyPS
[07]: https://www.powershellgallery.com/packages/platyPS
[08]: https://learn.microsoft.com/powershell/utility-modules/platyps/overview
[09]: https://learn.microsoft.com/powershell/utility-modules/platyps/step-1-create-new-markdown-help
[10]: https://learn.microsoft.com/powershell/utility-modules/platyps/step-1-update-markdown-help
[11]: https://learn.microsoft.com/powershell/utility-modules/platyps/step-2-edit-markdown-help
[12]: https://learn.microsoft.com/powershell/utility-modules/platyps/step-3-test-markdown-help
[13]: https://learn.microsoft.com/powershell/utility-modules/platyps/step-4-convert-publish-help