Overview

Manage your product documentation under Docs. Your team can write pages, ask Brew to draft them, and release the versions that agents and help-center readers use.

The same collection of docs supports both uses, with separate controls for agent access and public visibility.

Write, edit, and release

1. Create a draft. Ask Brew to write from connected repositories, start a blank doc, or bring existing content. See Drafting.
2. Edit it with your team. Changes autosave as working drafts. Use the visual editor and Preview to check the result. See Editing.
3. Release it. An owner makes the revision current for downstream readers. A new doc is unavailable to agents' documentation tools and public readers until its first release; later edits leave the previous release in use. See Releasing.

Use folders and tags to organize the collection. Markdown covers supported formatting, including callouts, accordions, and video embeds.

Keep documentation checked against your code

Releasing a doc requests verification of its checkable claims against connected repositories. When later checks find a contradiction, Teaflask can propose a correction for review without changing the released page automatically.

Not every page has claims that code can verify, and a release does not depend on verification succeeding. See Verification for the checks, statuses, and review process.

Choose where docs are available

• Agents: enable their documentation tools and choose a folder or tag scope in Agent knowledge.
• Help center: choose which released docs are shown and whether the site is live. Use Show in Help Center to control each doc’s public visibility.

Hiding a doc from the help center does not exclude it from an agent's knowledge. Use the agent's scope to control that access.