Help authoring doc with examples and recommended authoring guidelines.

[BurtBiel]

No description provided.

[azurecla]

Hi @BurtBiel, I'm your friendly neighborhood Azure Pull Request Bot (You can call me AZPRBOT). Thanks for your contribution!

In order for us to evaluate and accept your PR, we ask that you sign a contribution license agreement. It's all electronic and will take just minutes. I promise there's no faxing. https://cla.azure.com.

TTYL, AZPRBOT;
#Closed

[derekbekoe]

The backslash is causing some chars to be escaped when the doc is formatted. Consider using / instead as it would align more with Linux users. #Resolved

[derekbekoe]

🕐 #Resolved

[BurtBiel]

@derekbekoe comments addressed

---

In reply to: 237295359 [](ancestors = 237295359)

[derekbekoe]

[tjprescott]

Docstring and SDK Text are really the same thing because the SDK text is a docstring. #WontFix

[BurtBiel]

I was thinking here that we may wrap an SDK call in a custom command, in which case a docstring on the wrapper would override the SDK docstring. I think it's worthwhile to call out the SDK strings as separate from the product docstrings since they can't be changed.

---

In reply to: 73391384 [](ancestors = 73391384)

[JasonRShaver]

[yugangw-msft]

Just for clarification, does this mean the help text in register_cli_argument is also not recommended. I thought that is a nice data-driven approach.
The rest look good to me. #ByDesign

[BurtBiel]

for quick documentation, using the register help= format is fine. If the whole/most of the command needs its help to be re-written, we're better off unifying the help into a single YAML string rather than registering each param just to add the help tag to it.

---

In reply to: 73418361 [](ancestors = 73418361)