API Reference
RuleGuidance
Optional structured guidance for a rule (portable, inline).
Inheritance
- Object
- RuleGuidance
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Property Rule.Guidance
- Property DummyTestimoDebug.Guidance
- Property DummyForestBackup.Guidance
Constructors
public RuleGuidance() #Inherited Methods
Properties
public String Summary { get; set; } #Short, reader‑friendly summary of the risk or configuration.
public String WhyItMatters { get; set; } #Explains impact and rationale behind the rule.
public List<String> HowToInvestigate { get; set; } #Suggested steps to triage and collect more evidence. Setter stays available for object initializers and deserialization.
public List<String> HowToFix { get; set; } #Recommended remediation steps. Setter stays available for object initializers and deserialization.
public List<String> References { get; set; } #Links to documentation and references. Setter stays available for object initializers and deserialization.
public List<RuleExample> Examples { get; set; } #Code or command examples for documentation. Setter stays available for object initializers and deserialization.
public Boolean SummaryIsMarkdown { get; set; } #Whether the Summary is provided in Markdown.
public Boolean WhyItMattersIsMarkdown { get; set; } #Whether WhyItMatters is provided in Markdown.
public Boolean HowToInvestigateIsMarkdown { get; set; } #Whether HowToInvestigate items are Markdown-formatted.
public Boolean HowToFixIsMarkdown { get; set; } #Whether HowToFix items are Markdown-formatted.