Collaboration
The dashboard includes a full editorial workflow so docs changes ship with the same rigor as code. Everything below lives under your project in the dashboard and is also available via the Collaboration API.
Reviews
Request review on changed pages before they publish. Reviewers see a diff, can comment, and approve or request changes — like a lightweight PR flow for docs edited in the web editor.
If your docs live in a git repo, use normal PRs — Syntext builds a preview for every PR automatically. Reviews are for content managed in the web editor.
Approval Gates
Require sign-off from specific people before certain paths can publish:
- Define a gate with a path pattern (e.g.
api-reference/**,pricing) and required approvers - Publishes touching gated paths are held until approved
- Rejections include a reason and notify the author
Use gates for legally sensitive pages, pricing, and security documentation.
Scheduled Publishing
Stage content now, publish it later — e.g. docs for a feature that launches Tuesday 9am:
- Save the content (it stays unpublished)
- Create a schedule with the go-live time
- Syntext publishes and rebuilds automatically at that time
Schedules can be canceled any time before they fire.
Preview Links
Create shareable links to unpublished content for external reviewers — optionally password-protected and expiring. No Syntext account required to view.
Style Linter & Rules
Enforce a consistent voice across all writers:
- Built-in rules — broken links, missing descriptions, heading structure
- Custom style rules — terminology ("use sign in, not login"), banned phrases, tone
- Auto-fix — mechanical violations can be fixed in one click
- Runs in the editor as you type, and on demand via
POST /lint
Pair with stx check to enforce the same rules in CI.
Glossary
Define canonical terms once:
- Terms get hover definitions on the deployed doc site
- The linter flags inconsistent usage of glossary terms
- Manage in the dashboard or via the API
Content Ownership
Assign owners to path patterns (guides/** → @sarah). Owners are notified when their pages go stale (90+ days without updates) or receive negative feedback — no more orphaned docs.
Access Control
For docs that shouldn't be fully public:
- Access rules — restrict path patterns to audiences or authenticated users
- IP allowlists — restrict access to office/VPN ranges
- Access logs — audit who accessed gated content
- Access check API — test rules before rolling them out
For tiered content (e.g. partner-only pages), see Audience Gating.