search

gaelcolas / Sampler

Module template with build pipeline and examples, including DSC elements.
MIT License
171 stars 42 forks source link

Add highlights to the DSC Resource README template #448

Closed johlju closed 10 months ago

johlju commented 1 year ago

Suggest adding all possible highlights to the README template of a DSC resource, the README file that is used to generate the Wiki documentation. Recently there were added support for these in the GitHub repository wiki.

[!NOTE]
Highlights information that users should take into account, even when skimming.

[!TIP] Optional information to help a user be more successful.

[!IMPORTANT]
Crucial information necessary for users to succeed.

[!WARNING]
Critical content demanding immediate user attention due to potential risks.

[!CAUTION] Negative potential consequences of an action.

johlju commented 10 months ago

There are no template files that actually have a NOTE: or similar today, so closing this as not fixed.