Documentation Formats

Do

• Use caps when referring to the proper component, e.g. "The Modal component presents users with...".
• Use lowercase when referring to an instance of a component, e.g. "...the spacing around a modal container".
• Use HTML with backticks when referring to the code itself, e.g. "Define each prop on <bolt-modal>".
• Wrap prop names and prop values with backticks, e.g. "The width prop is set to optimal by default".

Don't

• Use the HTML and the component name interchangeably, e.g. "The <bolt-modal> component". Instead use the name, "The Modal component", unless you specifically mean the HTML.
• Use component tag name without brackets, e.g. bolt-modal. Either include brackets or use the component name instead.
• Say "Bolt Modal component". Just say "Modal component".

Also reference Bolt Doc Writing Guide.