FAQ
Frequently asked questions about Syntext.
General
How is Syntext different from Mintlify or ReadMe?
Three things: code annotations (API reference generated from doc comments in your actual source, with drift detection when code and docs diverge), an AI assistant that reports what it couldn't answer as a ranked gap list, and content health analytics that treat docs as a product with metrics. Content is standard MDX in git — no proprietary editor lock-in.
Do I have to change my code to use Syntext?
No. Existing JSDoc, docstrings, Go doc comments, Javadoc, PHPDoc, and C# XML docs are parsed with zero configuration. @stx directives are optional enhancements — see Annotations.
What languages are supported for annotation parsing?
TypeScript/JavaScript, Python, Go, Rust, Java/Kotlin, PHP, and C# — plus Ruby in hosted builds (the stx CLI has no local Ruby parser). Full matrix.
Can I self-host?
The doc site output is static and portable, and a self-hosted deployment guide covers hosting the built site yourself. The managed platform (builds, AI, analytics, collaboration) is hosted by Syntext.
Content
Is my content locked in?
No. Your docs are plain MDX files in your own repository. Leave anytime — your content already lives with you.
Can I keep some pages private?
Yes — use audience gating for tiered access (e.g. partners), or make the whole site password-protected, invite-only or SSO with Site visibility. Both are managed in Settings › Access. Path-based page rules and IP allowlists can be saved there too, but doc sites don't enforce them yet — see access control.
Does Syntext support versioned docs?
Yes, on the Pro plan: list your versions under versioning.versions in syntext.json, each built from its own branch or tag, and readers get a version switcher and /{label}/ URLs. See Versioning.
Can non-developers edit docs?
Yes — the web editor gives writers a browser-based editor with live preview, AI assistance, linting, and review workflows. No git required.
AI
Is my content used to train models?
No. Your content is used only to answer questions about your own docs. It is never used for model training and never shared with other customers.
What happens when the AI doesn't know an answer?
It says so rather than inventing one, and the question is logged as a documentation gap in Insights › Assistant so you can write the missing page.
Can I put the AI assistant on my marketing site or in my app?
Yes — one script tag. See the widget recipe.
Billing & Limits
What counts against my plan?
Builds (including PR previews) and AI queries, metered monthly per organization. Current usage is under Billing in the account sidebar; limit behavior is documented in Rate Limits.
What happens if I hit my AI query limit?
The assistant shows a friendly limit message to visitors, and the API returns 402 USAGE_LIMIT_EXCEEDED. Your doc site, search, and everything else keep working normally.
Security
How are API keys stored?
Only a SHA-256 hash is stored — the full key is shown once at creation. Keys support scopes (full, build, read), expiry, rotation, and revocation.
Are webhooks verified?
Yes — inbound GitHub webhooks are signature-checked, and unsigned or mis-signed deliveries are rejected.