TinyCase
Back →

For AI agents: see llms.txt for a full documentation index. Every page is also available as markdown — request the URL with a .md suffix or an Accept: text/markdown header.

Docs / Getting Started / Writing and Publishing Docs

Writing and Publishing Docs

Public docs, an internal knowledge base, and the two ways to author them.

Writing and Publishing Docs

Docs are a Pro feature with two separate uses: a public knowledge base
your customers (and the AI chat on your docs site) can read, and an
internal one only staff and the internal AI tools see.

This very page is written that way — it's part of a public collection.

Public vs. internal collections

A collection is either public or internal, decided when it's created — not
per page. Public collections show up on your docs site
(tinycase.app/docs for you, your own portal for customers) and are the
only material the customer-facing AI chat can quote from. Internal
collections power the case-sidebar AI tools (draft, doc search) and are
otherwise staff-only, from tinycase.app/docsInternal KB.

Your docs link only appears in the customer portal once you have at least
one public collection with at least one page in it — an empty or
all-internal knowledge base doesn't show a broken "Docs" link.

Two ways to write pages

  • The block editor — write pages directly in the app, no local tooling.
    Supports inline image uploads. Anything created this way stays editable
    in the app.
  • Markdown + the CLI — if you'd rather keep docs in your own git repo,
    the open-source CLI pushes a
    docs/ folder (a collections.yml plus markdown files) straight to your
    knowledge base. Pages published this way are read-only in the app
    your repo is the source of truth, and a push replaces the whole set:
    anything missing from the push gets deleted here too.

Both paths render identically to readers; which one you use per collection
is just a matter of where you'd rather edit. See API Tokens & the Docs
CLI
for the token and CLI setup itself.

Keeping docs worth searching

Stale docs actively hurt: the AI tools will confidently repeat something
that's no longer true. Every page tracks when it was last confirmed
current, and flags itself after 90 days without a content change — editing
a page (or a CLI push that actually changes it) resets the clock, but a
no-op push doesn't. Use the Mark as reviewed button on a page you've
checked and left as-is.

Ask a question