Extract authored Bicep README Notes into an adjacent, tracked sidecar.
One-time migration only. Copies the body of the top-level ## Notes section from README.md to README.notes.md without overwriting either file. Existing sidecars are left unchanged; normal documentation generation reads only the sidecar, never README Notes.
avm docs export-notes
Export-AvmReadmeNote [[-Path] <string>] [-SkipModuleVersionCheck] [-WhatIf] [-Confirm] [<CommonParameters>]Directory containing the existing README.md. Defaults to the current directory. Run once per module with authored Notes.
| Property | Value |
|---|---|
| Type | String |
| Required | false |
| Position | 1 |
| Default value | $PWD.Path |
| Accept pipeline input | false |
| Accept wildcard characters | false |
Skip the PowerShell Gallery check that otherwise stops the command when a newer Avm.Authoring version is available. Writes a warning once.
| Property | Value |
|---|---|
| Type | Switch |
| Required | false |
| Position | named |
| Default value | False |
| Accept pipeline input | false |
| Accept wildcard characters | false |
avm docs export-notes -Path ./avm/res/storage/storage-accountSystem.Management.Automation.PSObject