# 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. | If you need to… | Go to | |---|---| | Understand the available public routes | Find the right published route | | Identify fields and controls on a route | Understand the reader surface | | Read a document or use a reader action | Use the published surface | | Interpret a sign-in, empty, pending, or access state | Handle route and access branches | | Respond to an error | When the route does not work | | Continue with document administration or issue work | [Document changes](doc:document-changes) or [Work with an issue](doc:work-with-an-issue) | | Review versions or get general help | [Project versions](doc:project-versions) or [Getting help](doc:getting-help) | 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. | Reader goal | Reader action | |---|---| | Open the project | Have the published project destination. | | Browse an audience | Have the published audience destination. | | Read a 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. | | Open a preview | Have the published preview destination. | | Read technical documentation | Select **Technical**. | | Read a technical entity | Have the technical entity destination. | | Review a version | Have the published version destination. | | Browse a version audience | Have the published version audience destination. | | Read a version document | Have the published version document destination. | ## 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](doc:documents-overview). For version review and comparison, see [Project versions](doc: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 | Field label | Type | Required | Where it appears | |---|---|---:|---| | **Work email** | Email | Yes | Developer access area sign-in | | **Key name** | Text | No | Developer access area API-key form | | **Email** | Email | Yes | Changelog subscription | | **Add a reply** | Text area | No | Public issue page | 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. | Situation | What appears | |---|---| | The developer access area is signed out or has sent a link | The sign-in form or link-sent message | | The developer access area is signed in and the account is available | The signed-in bar, checklist, API keys, and usage | | No API keys exist | `No keys yet — create one to start calling the API.` | | A key is active | **Revoke** | | A key is revoked | `Revoked` | | The changelog subscription is pending | `Check your inbox — confirm the email to finish subscribing.` | | Changelog tags are available | **All** and tag buttons | | A reply is sending or contains no trimmed text | **Send** is disabled | | The document has an authenticated session and an id | **Edit this page** | ## When the route does not work Use the exact message on screen to choose the next action. | What you see | What to do | |---|---| | `Loading document...` | Wait for the document page to finish loading. | | `Document Not Found` | Check the document route values. | | `This document is not accessible.` | Check the public document address or use the project’s published route. | | `That sign-in link is invalid or has expired. Request a new one below.` | Request a new sign-in link. | | `Couldn't subscribe. Check the address and try again.` | Check the address in **Email**, then select **Subscribe** again. | | `Couldn't load the changelog. Try again later.` | Open the changelog again later. | | `This link can't verify you're the reporter — reply from the device you reported from, or email us.` | Reply from the device used to report the issue, or email the support address provided to you. | | `Couldn't send your reply. Please try again.` | Check the reply text and select **Send** again. | | **Project Not Found** with `Invalid project URL format` and `Error Code: 404` | Check the project route format. | ## Continue from published documentation After reading a public document, continue with the page that owns the next task: - [Documents overview](doc:documents-overview) explains document organization and opening. - [Create and edit a document](doc:create-and-edit-a-document) covers source-document creation and editing. - [Document changes](doc:document-changes) covers document states and available actions. - [Project versions](doc:project-versions) covers version review and comparison. - [Work with an issue](doc:work-with-an-issue) covers issue work beyond a public reply. - [Getting help](doc:getting-help) routes general support needs. - [Basic terminology](doc:basic-terminology) defines shared product terms.