A published documentation portal lets you explore documentation that a project has made available to its audiences. You can use the portal navigation to move between audiences, categories, collections, and individual documents without opening the project workspace.
Overview
Published documentation is organized so you can find information at the level that is most useful to you. Start by selecting the appropriate project audience, then use the documentation navigation to browse the available categories and collections. Within a collection, you can open documents and follow their hierarchy to more specific topics.
This view is intended for readers of documentation rather than project editors. You can browse published content, open documents, and move between related sections. Project management actions, such as Delete Project or Delete Documents, are available in the project workspace and are not part of normal published-documentation browsing.
A project can make documentation available for different audiences. For example, an audience may contain its own set of categories, collections, and documents. If you cannot find a topic, confirm that you are viewing the audience intended for your role or use case.
📷 Screenshot pending: A published documentation portal showing the audience area, Published Docs Nav, and document content.
Prerequisites
Before you start, make sure that:
- You have the published documentation link for the project you want to read.
- The project owner has published documentation for at least one audience.
- You know which project audience is relevant to you.
- Your browser can access the portal link provided by your organization.
- If the documentation is restricted, you have any required access or sign-in permissions.
Step-by-Step Instructions
-
Open the project’s published documentation link in your browser.
-
Select the audience that matches the documentation you need.
-
Review the available sections in the Published Docs Nav.
-
Select a category in the Published Docs Nav to display the content grouped under that category.
-
Select a collection to view the documents that belong to that collection.
-
Select a document title to open its published content.
-
Use the document hierarchy shown in the navigation to move to a parent, child, or related document.
-
Select another category when you need to switch to a different subject area.
-
Select another audience when the current audience does not contain the information you need.
-
Return to the project’s documentation entry point when you want to restart your browse path from the audience selection.
📷 Screenshot pending: The Published Docs Nav expanded to show categories, collections, and nested documents.
Tips and Best Practices
-
Start with the audience first. Documentation can differ by audience, so browsing the correct audience prevents you from missing content that is published elsewhere in the same project.
-
Use the hierarchy instead of opening documents at random. Categories provide broad groupings, collections organize related material, and document nesting helps you move from overview content to detailed instructions.
-
Treat a collection as a reading path when one is available. Documents grouped in the same collection are typically related and may be easier to understand when read together.
-
Check nearby entries in the Published Docs Nav after opening a document. A topic may have child documents with additional procedures, reference material, or related explanations.
-
If a document link does not show the expected content, return to the audience level and confirm your selection. The same project may publish different document structures to different audiences.
-
Do not use workspace-only options for reader tasks. Labels such as Open Project Dashboard, Projects, Documents, Delete Project, and Delete Documents belong to project administration areas. For published content, use View Published Docs or 🌐 View Published Docs when starting from a project workspace.
-
If you are viewing a project in the application and need the reader-facing portal, select View Published Docs. This opens the published experience rather than the editing and management workspace.
Related Pages
- Open a Project’s Published Documentation
- Choose a Documentation Audience
- Find Documents in a Published Portal
- Use Project Documentation in the Project Workspace
- Manage Published Documentation
Troubleshooting
I cannot find the document I need
Select a different audience and review its categories and collections. Documentation can be published separately for each audience, so the topic may not appear in the audience you initially selected.
The published portal does not show any documentation
Confirm that you opened the project’s published documentation link rather than the project workspace. From the workspace, select View Published Docs or 🌐 View Published Docs. If the portal is still empty, the project may not yet have published content for that audience.
I can see a category but not the expected document
Open the category and review all available collections and nested document entries in the Published Docs Nav. The document may be located under a collection or lower level of the hierarchy rather than directly under the category.
Was this page helpful?