How to Write Documentation

To write documentation on DeveloperHub, click anywhere in the editor page to start writing.

Page Sections

Pages must have a title and content.

Title

The title of the page is visible in:

1. The index of the documentation.

2. The title of the browser tab.

3. The URL of the page.

Choose the title carefully to be meaningful to your readers.

Content

The content of the page can consist of text, tables, images, links, code blocks, lists, information boxes, and much more! Have a look at blocks to find all the content that we natively support.

Saving

To save a page, click Save Draft on the bottom right. Your edits will be saved in draft mode until you publish them. Every edit you make is saved in the page history.

When you are ready to publish the changes to your readers, click Publish.

Spell Check

Your browser’s spell checker is doing its job simultaneously.