Skip to main content

Publish your first portal

This walkthrough follows the Catalog to portal checklist the Authoring Overview shows a new workspace. It needs the authoring entitlement and, for the Scribe and Slate steps, their previews (Plans and entitlements).

1. Choose your catalog​

  1. Open Authoring Overview from the suite dropdown (Route/authoring).
  2. In the scope header, pick a Project, a Version and the Preview environment. The Production environment and published versions are read-only, so author on a draft in Preview.
  3. The readiness hero now reads Set up your first portal with a Start setup action, and the checklist shows the steps and their status (Done / Next / To do / Unavailable).

2. Fill documentation gaps​

  1. Open Scribe — the content workspace. The left pane lists the version's paths and schemas with status chips (Needs attention, Undocumented, Stale, In review).
  2. Select an undocumented path. Write its summary and description in the Edit view; Preview shows the rendered reference; Changes diffs your draft against what is saved.
  3. Save (Ctrl / ⌘+S). A save re-reads the server copy first, so a change made elsewhere becomes a Conflict to resolve rather than an overwrite.
  4. For the whole version at once, open the Scribe dashboard and use Auto-fill missing path summaries or Document undocumented schemas — a bulk job through the Suite's LLM gateway, once an API key is saved in Scribe settings.

3. Review citations and examples​

The bulk run writes its documentation to the authoring service. Review it in the content workspace's Preview and Changes views, and in Stale alerts, where a rewrite can be applied with Update or Dismissed. Example payloads come from Generate from schema, a deterministic render of the schema. Set the project's tone first in the style guide.

In this preview the per-target proposal controls — the Generate buttons beside each field and the Proposals and evidence inspector's cards — are present but not yet wired; the bulk jobs are the path that reaches the model.

4. Design the portal​

  1. Open Slate. The visual builder renders the portal from the version's catalog in a sandboxed frame, at desktop, tablet and mobile widths.
  2. Theme sets the logo, colours, typefaces and colour mode; Navigation the global toggles and sidebar sections; Content blocks the landing page. Each has a live preview. In this preview these edits apply to the session only — their Save buttons say so.
  3. Site settings are saved: code-sample defaults, SEO, analytics, access control and indexing. Saving them the first time creates the project's documentation site, named after the project's slug.
  4. Preview renders the site in a browser frame and, on endpoint pages, sends a real request with Try it live.

5. Build, export and publish​

  1. Export builds a self-contained ZIP in your browser — Build & Download ZIP — for any static host; Versions builds a bundle with several published API versions and a latest alias.
  2. On the hosted plan, builds are recorded on the deployment control plane and appear on the site dashboard and in build history; the Release Center promotes a build to preview or production and rolls it back. The studio does not start a build itself yet.
  3. Custom domain puts a promoted site on your own hostname with automatic TLS.

Back on the Authoring Overview, the checklist's Publish to production step completes when the hosted plan has promoted a build.