Help Center

In-product documentation is hosted in the docs_help_center repository on GitHub (private to organization members) and the Help Center component is used on Real-Time Manager. You can find more information about the component on the Technical Writing Playbook (internal organization access only).

The in-product documentation has specific style characteristics that must be followed:

• Always start the documentation with H2 (##).
• Use bold only in the first mention of a product in the entire documentation.
• Don't use bold with links.
• Use - to create unordered lists (NOT *).
• Use > (blockquote) to create a highlight box.
• After using a link, add the {: target="_blank"} shortcut: text{: target="_blank"}
• Don't add spaces at the end of the markdown file.
• Use numbered lists: 1., 2., 3., …
• Try not to add text between a numbered list. If you add a numbered list, a text, and then continue the numbered list, it'll render as 1 again:
  1. Text Text text text
  2. Text → it'll render as 1

If it's absolutely necessary to add text between a numbered list, contact the UX Engineering team and ask them to add this functionality to selectors.

If a specific rule isn't described in this section, you should follow the rules for the documentation site.