Skip to content
Syntext
Start free
NewSyntext 2.0 is here

Docs that write
themselves true.

Annotate your code with @stx, push to GitHub, and Syntext compiles a live documentation site — with an Assistant that answers from it and tells you what’s missing.

Start freeRead the docs
brew install syntext-dev/tap/stx
docs.acme.dev

Guides / Keys

Rotate an API key

Rotate keys on a schedule or after a leak. Both keys remain valid until you revoke the old one, so nothing breaks mid-deploy.

// rotate with zero downtime
const next = await stx.keys.rotate("key_9f2a")
await deploy({ key: next.secret })

Synced from @stx in src/keys.ts · 2m ago

  • 41smedian push-to-live
  • 142pages synced from @stx
  • 98%docs in sync with code
  • 0pages edited by hand

Sample figures from the Acme API project, last 30 days.

How it works

Annotate once. Push. It’s live.

No separate docs repo to forget about. Your code is the source; Syntext keeps the site honest.

  1. 01

    Annotate

    Write docs where the truth lives — next to the function. Tags compile into guides, params and examples.

    /**
 * @stx guide "Rotate an API key"
 * @stx param keyId  the key to rotate
 */
export async function rotate(keyId) {
  2. 02

    Push

    Every push to GitHub runs a build: fetch, parse, compile, embed, index, deploy. Branches get previews.

    $ git push origin main
→ build #482 · main · 7be02d4
  parse    ✓ 38 annotations
  compile  ✓ 142 pages
  deploy   ● going live…
  3. 03

    It’s live

    Atomic deploys to your domain in under a minute, with search and the Assistant updated in the same step.

    Live41s
    docs.acme.dev7be02d4 · 142 pages · just now

Assistant

Answers with sources. Flags what’s missing.

Readers ask in plain language. The Assistant answers only from your docs and code, cites the exact page, and tells you when it couldn’t.

  • Every answer links its sources — page and line
  • Says “not documented yet” instead of guessing
  • Unanswered questions become one-click page drafts
Ask Acme APIHigh confidence

How do I rotate an API key without downtime?

Answer

Create a new key with the same scope, deploy it, then revoke the old one. Both keys stay valid until you revoke stx_live_…9f2a.

Sources
1Rotate an API key
2keys.rotate()
Was this helpful?
Gap flagged

“Can I scope a key to one project?” — asked 41 times

No page answers this yet. Draft one from @stx annotations in src/keys.ts?

  • Live
    docs: rotate keys guidemain · 7be02d4 · 12m ago
  • Preview
    feat: v2 paginationpreview/v2 · 3c9e1f0 · 25m ago
  • Building
    fix: webhook retriesfix/retry · a3f9c21 · now
  • Live
    docs: pagination guidemain · c22a01f · yesterday
preview-v2--acme-docs.syntext.devPreview

Deployments

Every branch a preview.
Every deploy reversible.

Open a pull request and get a preview URL in the PR. Promote it when it’s right; roll back in one click if it isn’t.

  • Atomic pointer-swap deploys — no half-published sites
  • Streaming logs per stage, from fetch to deploy
  • Preview links posted to the pull request

Surfaces

One source. Every surface.

The same annotated source powers your reference, SDK samples, the MCP server and the in-app widget.

  • API reference

    Generated from your OpenAPI spec and @stx tags, with a request playground.

    POST /v1/keys/:id/rotate200 Returns the new key

  • SDK samples

    Typed examples in TypeScript, Python and Go, kept in step with every release.

    import { Acme } from "@acme/sdk"
await acme.keys.rotate(id)

  • MCP server

    Give Claude, Cursor and other agents your docs as tools — one URL.

    { "acme-docs": {
  "url": "https://acme-docs.syntext.dev/_mcp" } }

  • Chat widget

    Drop the Assistant into your app or dashboard with one script tag.

    How do webhooks retry?Up to 8 times, with backoff…

Pricing

Priced per organization,
not per seat.

One plan covers every project in your workspace. Annual billing gets two months free.

Free

$0/mo

For side projects

  • 1 project
  • 50 pages
  • 200 assistant queries / month

Starter

$49/mo

For a first public docs site

  • 5 projects
  • 500 pages
  • 500 assistant queries / month

Pro

Popular

$149/mo

For API teams

  • 25 projects
  • 5,000 assistant queries / month
  • @stx, drift detection, SSO

Enterprise

Custom

For regulated & self-hosted

  • Unlimited everything
  • Self-hosted option
  • Audit logs & SLA

Free for side projects · no card needed

Ship docs that stay true.

Connect a repository, push, and watch your docs go live with every merge.

Start freeTalk to us
brew install syntext-dev/tap/stx