Preview Published Documentation

Preview your published documentation to confirm that external readers can access the correct project content. This review helps you verify the reader-facing experience before sharing the documentation with customers, teammates, or other stakeholders.

Overview

Published documentation is the external, reader-facing version of your project’s user guides and manuals. Unlike the internal project workspace, this view is designed for people who need to read the documentation rather than manage the project.

Use the published preview when you want to confirm that your documentation is available after publication, check how readers move between sections, or validate that the expected user-facing content appears. You can open the published view from the project’s review area by selecting 🌐 View Published Docs.

The published documentation experience may include navigation entries such as User Docs, 📋 User Manuals, and User Guides. These entries help external readers find the type of documentation they need. Return to the project workspace when you need to make changes, review project information, or manage publication.

📷 Screenshot pending: The published documentation view showing reader-facing navigation and documentation content.

Prerequisites

Before you start, make sure that:

You can access the Projects area.
You have selected the correct project from the project list.
Your project documentation has been published and is shown as Published.
You can access the project review area, where 1 Review Summary is available.
You know which user guide or manual you want to check as an external reader.

Step-by-Step Instructions

Select Projects to open the list of available projects.
Use the Search projects... field if you need to locate a specific project.
Select the project you want to review.
Confirm that the project is marked Published before opening its external documentation.
Open 1 Review Summary in the selected project.
Select 🌐 View Published Docs to open the reader-facing documentation preview.

📷 Screenshot pending: The Review Summary area with the 🌐 View Published Docs action highlighted.

Review the opening page to confirm that the expected published documentation is displayed.
Select User Docs to review the primary documentation available to external readers.
Select 📋 User Manuals to check the available manual content.
Select User Guides to confirm that guide content is organized for readers.
Open a documentation item and verify that its title, text, and navigation appear as expected.
Select Back to Review when you want to return to the project review area.
Select ← Back to Projects when you want to leave the current project and return to the project list.

Tips and Best Practices

Preview documentation only after confirming that the project is Published. This helps you review the same reader-facing version that external users are expected to see.
Start your review from 1 Review Summary. The 🌐 View Published Docs action is the clearest way to move from internal project review to the external documentation experience.
Check more than the first page. Open User Docs, 📋 User Manuals, and User Guides so you can confirm that readers can find content through the published navigation.
Review the published view as a reader would. Focus on whether page names are understandable, manuals are easy to locate, and the intended documentation appears in the correct section.
Use Back to Review instead of relying on your browser’s back button when you want to continue working with the project review. This keeps you in the project workflow.
If you manage multiple projects, return to Projects and use Search projects... to avoid previewing the wrong project’s documentation.

Troubleshooting

The 🌐 View Published Docs action is not available

Return to the project and verify that it is marked Published. If the project is not published, complete the required publication process before attempting to preview the external documentation.

The published page does not show the documentation you expected

Select Back to Review and confirm that you opened the correct project. Then use 🌐 View Published Docs again and review the entries under User Docs, 📋 User Manuals, and User Guides.

You cannot find the project you need

Select Projects and enter the project name in Search projects.... Open the matching project, then go to 1 Review Summary to access its published documentation preview.