Published documentation

Published documentation at a glance

Published documentation is the reader-facing version of a project’s documentation. Use it to choose an audience, read a document, inspect technical content, use the API surface, review changes, or get developer access.

A public route is a reader-facing address for one part of a project’s documentation. The public route family includes the project, audience, document, API, browse, changelog, developer, issue, preview, technical, entity, and version routes. The developer access area is the public area for sign-in links and API keys. The Changelog is the public area for release notes and documentation updates. The API surface is where readers review API content. A public issue is an existing report that can receive a reply.

Before you open a route

Use a published route when you have the project identifier and, where required, the audience, document, version, change-request, entity, or ticket value for that route. The route determines which public surface opens.

Find the right published route

Choose the public route by the result you want rather than by the name of the screen.

Prerequisites

• Have the project identifier for the published project.
• Have the audience, document, version, entity, change-request, or ticket value when the selected route requires one.

Steps

1. Choose the route that matches your goal.

   If you want to…	Open
   Browse a project’s audiences	Have the published project destination.
   Open an audience’s documents	Have the published audience destination.
   Read one document	Have the published document destination.
   Review API content	Select API.
   Browse collections	Have the published collections destination.
   Read release notes and documentation updates	Select Changelog.
   Get a developer sign-in link or manage API keys	Select the developer access area.
   Review a public issue	Have the public issue destination.
   Read technical content	Select Technical.
   Open a versioned document	Have the published version document destination.

Result: The selected reader-facing route opens.

For document organization and opening from the Documents destination, see Documents overview. For version review and comparison, see Project versions.

Understand the reader surface

The reader surface combines document content with navigation, route-specific controls, and forms for developer access, changelog subscriptions, and public issue replies.

Fields and route-specific forms

The document surface provides Report an issue and Download as PDF. The developer access area provides Email me a sign-in link, Sign out, Delete my account, Copy key, Revoke, Create key, and Open the API playground. The changelog provides Subscribe, RSS feed, JSON feed, and All. A public issue provides Send.

Reader navigation labels

The public navigation can include Technical, API, the developer access area, and Changelog. The rendered route also provides Search docs… and controls titled Search documentation, Download PDF, and Switch theme — System.

Use the published surface

Open and read a document

Use a document route when you need the published content itself.

Prerequisites

• Have the published document destination.

Steps

1. Open the published document destination.

2. Read the document content.

3. Select Download as PDF when you need a PDF copy of the page.

4. Select Report an issue when the published page needs a report.

Result: The document page remains available for reading, PDF download, or issue reporting.

Request developer access

Use the developer access area when you need a sign-in link or an API key.

Prerequisites

• Have the published project's developer access destination.

Steps

1. Open the published project's developer access destination.

2. In Work email, enter your work email address.

3. Select Email me a sign-in link.

   The page can display Check your inbox — we sent you a one-time sign-in link. It expires in 15 minutes.

4. If the sign-in link is rejected, request a new link after the page displays That sign-in link is invalid or has expired. Request a new one below.

5. After you sign in, enter an optional name in Key name.

6. Select Create key.

7. Select Copy key when the new key is displayed.

Result: The developer access area shows the account and API-key controls available for your signed-in state.

Subscribe to changelog updates

Use the changelog subscription when you want release notes and documentation updates by email.

Prerequisites

• Have the published project's Changelog destination.
• Have the email address for the subscription.

Steps

1. Open the published project's Changelog destination.

2. In Email, enter the subscription email address.

3. Select Subscribe.

   The page can display Check your inbox — confirm the email to finish subscribing.

Result: The changelog page displays the subscription status.

Review API content

Use the API surface when you need to review published API content.

Prerequisites

• Have the published project destination.

Steps

1. Select API.

Result: The API surface opens.

Reply to a public issue

Use a public issue route when you need to add information to an existing report.

Prerequisites

• Have the address of the public issue page.

Steps

1. Open the public issue page using its address.

2. In Add a reply, enter the reply text.

3. Select Send.

Result: The issue page processes the reply request.

Handle route and access branches

The same route can show different content depending on the sign-in phase, available records, key state, subscription state, or issue-reply state.

When the route does not work

Use the exact message on screen to choose the next action.

Continue from published documentation

After reading a public document, continue with the page that owns the next task:

• Documents overview explains document organization and opening.
• Create and edit a document covers source-document creation and editing.
• Document changes covers document states and available actions.
• Project versions covers version review and comparison.
• Work with an issue covers issue work beyond a public reply.
• Getting help routes general support needs.
• Basic terminology defines shared product terms.