Skip to content

Commit 86acd15

Browse files
authored
Update help-generation.md
1 parent 17a2a45 commit 86acd15

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

documentation/development-docs/help-generation.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ Whenever the public interface for a cmdlet has changed, the corresponding markdo
5353
- Accept pipeline input
5454
- Add/change output type
5555

56+
5657
#### Updating all markdown files in a module
5758

5859
To update all of the markdown files for a single module, use the [`Update-MarkdownHelpModule`](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelpModule.md) cmdlet:
@@ -71,6 +72,13 @@ This will update all of the markdown files with public interface changes made to
7172

7273
_This seems to work better when run from within the `help` folder itself (For e.g. to generate the help files for the [`Network`](src/Network) module run the cmd from under [`Commands.Network/help`](src/Network/Network/help)). Also, you will have to import the profile module from under <Repo base path>/artifacts/Debug/Az.Accounts/Az.Accounts.psd1_
7374

75+
**Note**: If you are doing for the first time for a new module, it may happen that even after calling Update-MarkdownHelpModule will not create new md files. In this case generate the markdown for a single command by using following command and post executing command Update-MarkDownHelpModule will generate all the other files
76+
77+
```powershell
78+
# New-AzDataBoxEdgeDevice is one of newly added cmdlets
79+
New-MarkdownHelp -Command New-AzDataBoxEdgeDevice -OutputFolder $PathToHelpFolder
80+
```
81+
7482
#### Updating a single markdown file
7583

7684
To update a single markdown file with the changes made to the corresponding cmdlet, use the [`Update-MarkdownHelp`](https://github.com/PowerShell/platyPS/blob/master/docs/Update-MarkdownHelp.md) cmdlet:

0 commit comments

Comments
 (0)