Docs and help

A docs surface that starts with architecture honesty

The help experience should teach people how to choose the right publish path, what the billing model actually means, and how the workflow behaves after they click publish.

Launch checklist

  • Connect one website to a verified publish destination
  • Create and refine the first article draft
  • Confirm how draft versus live publishing behaves on your stack
  • Verify credits, purchases, and subscription state in one place

Quick start

Choose the right integration lane first

The fastest path is not always the same path. The docs surface should help customers decide between native adapters, secure webhooks, and future rebuild or repo modes.

  • CMS teams start with native adapters, including WordPress, Webflow, Shopify, Wix, and Ghost
  • Custom app teams start with signed webhooks
  • Static content teams prepare for rebuild or Git workflows

Billing and credits

Explain the economics without hand-waving

Subscriptions grant entitlements, extra purchases mint immutable records, and backlink failures can trigger refunds through the same ledger model.

  • Ziina for checkout and payment events
  • Separate AI and backlink credit balances
  • One readable history for grants, purchases, and refunds

Publishing ops

Teach users what happens after they press publish

The docs should set expectations around validation, retries, destination IDs, and how live versus draft publishing differs across adapters.

  • Explain verification before publish, including Ghost Admin API and Wix site permission checks
  • Show retry and failure handling
  • Document how draft versus live behavior differs across each integration

Support posture for launch

Guide first

Start with opinionated setup guides for CMS and TypeScript-site teams before expanding into a full docs IA.

Safety language

Explain retries, verification, idempotency, and credit grants in plain language so customers know what the automation is doing.

Help customers self-select

The best docs reduce misconfigured integrations by helping teams choose the correct lane before they ever paste a token.