Workflow
Reviews, approval gates, scheduled publishing, ownership, style linting, and glossary for docs teams.
The dashboard includes a full editorial workflow so docs changes ship with the same rigor as code. Open your project in the dashboard → Workflow. It has six tabs — Reviews · Approvals · Schedules · Ownership · Linter · Glossary — and everything is also available via the Collaboration API.
Before Dashboard 2.0 these screens lived under Collaboration. An old link shows where the screen moved, with a button that takes you there.
Reviews
Workflow › Reviews. Request review on changed pages before they publish — from Request review in the web editor, or with the new review form (title, page path, reviewer, description). Filter by All, Pending, Approved, Rejected, or Merged; reviewers approve, reject, or merge — like a lightweight PR flow for docs edited in the editor.
Only the assigned reviewer or a workspace admin can decide a review, and nobody can approve a review they requested. The reviewer must be a member of the workspace other than you.
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
Workflow › Approvals. Record sign-off from specific people for certain paths:
api-reference/**, pricing) and required approversautoApproveForRoles) — roles whose changes the gate doesn't hold in the hosted MCP connectorUse gates for legally sensitive pages, pricing, and security documentation.
Gates record sign-off — they don't enforce it yet. A save in the web editor, a push or a deploy is not held while an approval is pending, and nobody is notified when an approval is requested, approved or rejected. Check Workflow › Approvals before you publish a gated page. The exception is the hosted MCP connector: its direct commits and publish_changes are refused for gated pages unless the gate auto-approves the caller's role. Owners are never held.
Scheduled publishing
Workflow › Schedules. Stage a page's content with a go-live time — e.g. docs for a feature that launches Tuesday 9am:
The dashboard lists every schedule with its status, and you can reschedule or cancel one while it is still scheduled — by the person who created it, or by a workspace admin.
When a schedule is due, Syntext publishes it within about a minute: it writes the content to the page — a commit on a GitHub project, a saved revision on a project written in Syntext — and starts a build. The schedule then shows as published, or as failed with the reason.
Who can change what
Any member can request reviews, request approvals, schedule publishes, create preview links, and lint. Configuring the workflow needs the admin or owner role: gates, linter settings, style rules, glossary edits, lint auto-fix, page ownership, access rules and IP allowlists. Reading access rules, IP allowlists and access logs needs admin too. The Collaboration API lists the role for every endpoint.
Preview deployments
Every non-production branch and pull request gets its own preview deployment. Previews live under Deployments › Previews, where you can open each one and Promote it to production.
Each pull request has a preview record — its branch, commit, author and preview URL. The GitHub integration creates and updates these records automatically; if you build previews in your own CI, record them with Create Preview. A preview URL is a normal deploy URL: there is no password or per-link expiry.
Style linter and rules
Workflow › Linter. Enforce a consistent voice across all writers:
Pair with stx check to enforce the same rules in CI.
Glossary
Workflow › Glossary. Define canonical terms once:
Content ownership
Workflow › Ownership. Assign owners to path patterns (guides/** → @sarah) and see which owned pages have gone stale — by default, no update in 90 days — and which pages have no owner at all.
Stale-page alerts
Turn on Email owners weekly, Post to Slack, or both, on the Ownership tab. Every Monday at 09:00 UTC, Syntext finds the owned pages with no change in more than the stale threshold (90 days unless you change it) and sends:
guides/api/** beats guides/**).Each stale page is alerted once per stale period. It's alerted again only after it's edited and goes stale again, or when you change the threshold. If a send fails, those pages are retried the next Monday.
Owners who have left the organization, or deleted their account, are not emailed; in Slack their pages are listed under Former member.
Configure the same settings from the API with Update Ownership Settings.
Access control
Who can read your docs is managed in one place: Settings › Access (it replaced the old Access control, Audiences, and collaboration access screens). It has five sections:
Doc sites do not enforce page rules or IP allowlists yet. They are stored, and the access check API evaluates page rules, but the deployed site does not consult either one when it serves a page. What a doc site does enforce today is site visibility and audience gating. Don't rely on a page rule or an IP allowlist to keep a page private.
When a private site can't be gated
A site set to Password, Invite-only or SSO is never shown publicly
because its sign-in can't be checked. If that ever happens, readers see a
This site's access control isn't configured page (HTTP 503) instead of
your docs, and the site's search, assistant and MCP endpoint
answer nothing (API clients get the error code access_control_not_configured).
The site comes back on its own once the problem is fixed; contact Syntext
support if you see this page. Public sites are not affected.
Too many sign-in attempts
A reader who gets the password or invited email wrong too often is asked to wait before trying again (about a minute, longer after repeated tries). When a site sees a large number of wrong attempts from many places at once, sign-in pauses for everyone for 15 minutes, and for longer each time it happens again within a day. Readers who are already signed in aren't affected.
Sign-in and password pages on doc engine v2
On a doc engine v2 site, the pages a reader sees before they're let in are drawn in the site's own preset — its accent, fonts and corners — instead of the standard Syntext pages:
SSO sites still redirect straight to their identity provider. A site picks this up on its next build; until then, and on every v1 site, the standard pages are shown. Forms, cookies, status codes and the password and token checks are unchanged.
For tiered content (e.g. partner-only pages), see Audience Gating.