A published audience slug identifies a specific audience area within your public documentation. You can use it to open the correct published experience, confirm that audience-specific content is available, and return to your publishing tools when changes are needed.
Overview
When you publish documentation, Atloria provides a public documentation area that can be accessed through View Published Docs or 🌐 View Published Docs. Within that published area, an audience slug distinguishes one audience from another.
An audience slug is the audience-specific part of the published documentation address. It helps ensure that readers reach the documentation intended for their audience, rather than a different audience or a general documentation landing page. For example, organizations may use separate published audiences for customers, partners, administrators, or internal teams.
You typically work with a published audience slug when you need to verify the reader experience after publishing, share an audience-specific documentation link, or identify why a reader is not seeing the expected documentation. The public navigation can also lead from an audience area to a specific published document.
📷 Screenshot pending: Published documentation view showing the audience-specific area and navigation to published documents.
Prerequisites
Before you begin, make sure you have:
- Access to the Atloria workspace that contains the documentation project.
- Documentation that has been published, indicated by the Published status.
- Permission to open publishing and settings options for the project.
- The correct public documentation project link or access to View Published Docs.
- The audience slug you want to verify or share, if it was provided by another administrator.
- At least one document available for the intended published audience.
Step-by-Step Instructions
Use these steps to open and verify a published audience identified by its slug.
-
Open the documentation project in Atloria.
-
Select Publishing to review the project’s publishing area.
-
Confirm that the documentation shows the Published status.
-
Click 🌐 View Published Docs to open the public documentation experience.
-
Locate the audience-specific section of the published documentation.
-
Check that the audience slug in the published link identifies the audience you intend to view.
-
Open the audience-specific link to display documentation for that audience.
-
Review the visible documentation navigation to confirm that the expected audience content is available.
-
Select a document from the published audience navigation to verify that its content opens correctly.
-
Use the browser’s address bar to copy the audience-specific published link when you need to share it with readers.
-
Return to Atloria and select Manage in Settings if the audience, publishing configuration, or available content needs to be changed.
-
Click 🌐 View Published Docs again after making publishing changes to verify the updated public audience experience.
📷 Screenshot pending: The Publishing area with the “🌐 View Published Docs” action used to open public documentation.
Understand the published link structure
A published documentation link can lead to different levels of the public experience:
-
Open View Published Docs to start at the published documentation area.
-
Use the project portion of the published link to identify the documentation project being viewed.
-
Use the audience-specific portion of the link to identify the published audience.
-
Use the final document-specific portion of the link, when present, to open an individual published document within that audience.
The audience slug is important because it keeps the reader within the correct audience context. If you share only a general project-level link, readers may need to navigate further before reaching the documentation intended for them. When you share an audience-specific link, readers can enter directly into the appropriate published documentation area.
Verify changes after publishing
If you update documentation or change publishing-related settings, verify the audience again after the update is published.
-
Return to the project’s Publishing area.
-
Confirm that the project remains marked Published.
-
Select View Published Docs.
-
Open the audience-specific published link.
-
Refresh the browser page to ensure you are viewing the latest published result.
-
Open an affected document to confirm that the audience can see the expected content.
-
Use Manage all versions → or 🕘 Go to Version Manager if you need to review documentation versions before confirming the published result.
📷 Screenshot pending: An individual published document opened from an audience-specific public documentation area.
Tips and Best Practices
-
Share the audience-specific link. When documentation is intended for a particular group, share the link that includes that audience’s slug rather than relying on readers to navigate from the general published documentation area.
-
Verify the Published status first. If documentation is not marked Published, readers may not be able to access the expected public content.
-
Test a document, not only the audience landing area. An audience may open successfully while a specific document is unavailable or does not display as expected. Open at least one relevant document after checking the audience link.
-
Use consistent audience names and slugs. Choose clear, stable audience identifiers so that shared links remain understandable and easier to maintain over time.
-
Review versions before publishing changes. Use Manage all versions → or 🕘 Go to Version Manager when you need to confirm which documentation version should be visible to the audience.
-
Keep public links current. If your organization changes its audience structure or publishing configuration, retest links that have been shared in emails, portals, onboarding materials, or support resources.
-
Use the public view for reader validation. The View Published Docs experience shows what readers can access. Use it as the final check after generating, importing, exporting, or updating documentation.
Related Pages
- Publish Documentation
- View Published Docs
- Manage Documentation Versions
- Manage Publishing Settings
- Generate Documentation
- Export Documentation
Troubleshooting
The audience-specific link does not show the expected documentation
-
Return to the documentation project.
-
Select Publishing.
-
Confirm that the documentation status is Published.
-
Click 🌐 View Published Docs.
-
Open the audience-specific link again and verify that you are using the correct audience slug.
-
Select a document from the audience area to check whether the issue affects the full audience or only one document.
You can open published documentation, but not the intended audience
-
Open View Published Docs.
-
Compare the audience-specific part of the link with the slug you were given.
-
Replace the link with the correct audience-specific link if you copied or received an incorrect one.
-
Select Manage in Settings if the correct audience is unavailable or requires configuration changes.
Updates are not visible in the published audience
-
Open Publishing.
-
Verify that the current documentation is marked Published.
-
Select 🕘 Go to Version Manager to review the version you expect to be public.
-
Return to 🌐 View Published Docs after confirming the version.
-
Refresh the audience-specific public page before checking the updated document again.
Was this page helpful?