PSDocs icon indicating copy to clipboard operation
PSDocs copied to clipboard

Allow option to show .bicepparam example rather than JSON parameters

Open Mantene opened this issue 2 years ago • 3 comments

Is your feature request related to a problem? Please describe.

We have switched over to using .bicep templates and .bicepparam files for parameters and gotten away from ARM/JSON. However, when the README.md file is generated, it only provides the JSON parameters file example.

Describe the solution you'd like

We would like PSDocs to provide a .bicepparam example instead of JSON when .bicepparam files are present or when a switch is passed.

Describe alternatives you've considered

We have tried to get the Set-ModuleReadMe.ps1 tool that is used in the CARML, but we don't seem to be able to get it to work at the moment.

Mantene avatar Aug 16 '23 12:08 Mantene

Thanks for raising your first issue, the team appreciates the time you have taken 😉

github-actions[bot] avatar Aug 16 '23 12:08 github-actions[bot]

Is this repository no longer maintained?

Mantene avatar Feb 07 '24 13:02 Mantene

Thanks @Mantene for your interest in PSDocs. Sorry we haven't been responsive on this.

We have plans to uplift PSDocs to address some challenges for Bicep users, but no immediate timeline for these.

BernieWhite avatar Feb 08 '24 10:02 BernieWhite