Drafting

Start a doc by asking Brew to draft it, writing it yourself, or bringing content from another tool. Each route gives you a document your team can edit before an owner releases it.

Ask Brew to draft from your code

Connect the relevant repositories under Settings > Integrations > GitHub, then open Brew and describe the page you need. Include the audience and what the page should help them do. For example: “Draft a guide for customers explaining how billing works, including adding funds and finding receipts.”

Follow the drafting work in the conversation. When Brew submits a finished document, it appears as a draft request in Docs for review. Connecting a repository does not, by itself, create documentation.

Open the request to review the draft:

• Approve & publish releases the document's newest draft. If you edited the document after Brew submitted it, your saved changes are included.
• Dismiss discards the request's drafts and closes the request.

Approval makes the content current; it is not just an acknowledgement that you have read it. Review the body and its intended audience before approving. See Releasing.

Write a doc yourself

Open Docs and choose New doc, or use New doc here from a folder's actions to create it in that folder.

Enter a title, then write the body. The title determines the doc's URL at creation. Renaming it later changes the title, not that address.

The editor autosaves your work. You can use the formatting toolbar and slash menu, then switch to Preview to check the page. See Editing.

Bring existing documentation

The dashboard does not have a bulk-import wizard. To move existing articles:

1. Export or copy each article from your current tool. Markdown is the stored format; raw HTML needs converting before it can be saved.
2. Create a doc for the article and transfer its content. Check headings, lists, tables, images, and links in Preview rather than assuming the paste preserved every detail.
3. File it in a folder if it should appear in help-center navigation.
4. Update links between articles to their new Teaflask addresses. Those links are not remapped automatically.
5. Review and release the doc when it is ready.

Valid Markdown does not always open in the visual editor. Some formatting requires Markdown source editing; Markdown explains the supported formats and the distinction.

A released doc left Unfiled can still be reached through help-center search and a direct link when it is shown on a live site, but it is absent from the sidebar. See Organizing.

An organization can hold up to 10,000 live docs, including unreleased drafts.