Writing Documentation

Writing documentation on DeveloperHub cannot be any easier. In your editor pages, click anywhere on the text in your documentation and start writing down. You can even use the AI Writer to help you craft the best content. Everything in the editor will be shown to you just as your readers - no split view.

Page Sections

Pages must have a title and content.

Title

The title of the page will be visible in:

1. The index of the documentation.
2. The title of the browser tab.
3. The URL of the page.

So 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, hit the Save Draft button at 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 the Publish button .

Spell Check

Your browser spell checker is doing its job right away.