Skip to content

Commit 28c4336

Browse files
Add reference to Wiki in USAGE.md (#298)
Add a reference to the documentation in the Wiki to the top of USAGE.md.
1 parent 28e20d4 commit 28c4336

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

USAGE.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
## Usage
33

44
#### Table of Contents
5+
* [Full Module Documentation](#full-module-documentation)
56
* [Logging](#logging)
67
* [Telemetry](#telemetry)
78
* [Common PowerShell API Patterns](#common-powershell-api-patterns)
@@ -130,6 +131,20 @@
130131

131132
----------
132133

134+
## Full Module Documentation
135+
136+
All commands for the module have "Comment-Based Help" available at your fingertips.
137+
You can access that help at any time by running:
138+
139+
```powershell
140+
Get-Help -Full <commandName>
141+
```
142+
143+
In addition to accessing it from the commandline, all of that help documentation is also available
144+
online on our [wiki](https://github.com/microsoft/PowerShellForGitHub/wiki).
145+
146+
----------
147+
133148
## Logging
134149

135150
All commands will log to the console, as well as to a log file, by default.

0 commit comments

Comments
 (0)