Writing documentation

Docs mode turns a page, and the pages inside it, into documentation.

Start documentation

1. Open the first page of your documentation.
2. Open More, choose Writing mode, then Documentation.
3. Add pages inside it for each topic.

To turn the mode off, choose its name at the top of the page, or open More, Writing mode and Turn off.

Write it

• Type / for callouts (Note, Tip, Warning or Danger), numbered steps, tabs and a table of contents that follows the page’s headings.
• Define variables such as {product} once in the Docs panel; they show their value everywhere, in exports and on share links too.
• Every code block has a Copy button.
• In documentation, Gyra writes to be followed: steps, exact names, and [TK] for anything missing.

Keep it current

The Docs panel shows when a page was last reviewed and by whom. Choose Mark as reviewed, and set a reminder every month, 3 months, 6 months or year. Pages due for review are listed, and links to pages that were deleted are pointed out.

Snippets are text written once on a page of their own, such as how to contact support. Place a snippet on any page of the documentation and every page shows the latest text.

Publish it as a site

On the documentation’s first page, open Share and choose Publish as a site. Its pages open through the same link, with a sidebar of all of them in order.