Link to a Published Document by Slug

This page explains how a document slug identifies one published document in its public documentation link. Using the correct slug helps you share a direct, reliable link to the exact document your audience needs.

Overview

When you publish documentation, Atloria provides a public documentation area where readers can browse content by project and audience. Each individual published document is identified in its public web address by a document slug.

The document slug is the document-specific part of the public link. In the published documentation structure, it appears after the project and audience portions of the address. This allows Atloria to open the correct document when someone selects or uses the link.

You typically need a document slug when you want to share a direct link in an email, internal portal, support response, onboarding guide, or another document. Rather than asking readers to browse through the published documentation manually, you can give them the address for the exact published page.

📷 Screenshot pending: A published document open in the public documentation area, with the document-specific slug visible in the browser address.

Prerequisites

Before you start, make sure you have:

Access to the project that contains the document.
A document that is available as Published.
Access to Documents in Atloria.
The correct audience selected in the public documentation area, if your project uses audiences.
Permission to open View Published Docs.

Step-by-Step Instructions

Select Documents from the Atloria navigation.
Select your project if you see the message Select a project to view documents.
Locate the document you want to share.
Confirm that the document is marked Published.
Select View Published Docs to open the project’s public documentation area.

📷 Screenshot pending: The Documents area showing the View Published Docs action used to open public documentation.

Select the appropriate audience section, such as User Guides, when the public documentation area displays audience choices.
Select the published document you want to link to.
Check that the document content and title match the page you intend to share.
Copy the address from your browser’s address bar.
Paste the copied address into the destination where you want to share the document.

The copied public address includes the document slug. Atloria uses that slug, together with the selected project and audience, to identify the individual published document. If you share the complete address, recipients can open the same document directly without first navigating through the documentation lists.

Tips and Best Practices

Share the complete public address rather than copying only the document slug. The complete address includes the project and audience context required to open the correct document.
Open the document from View Published Docs before copying its address. This confirms that you are using the reader-facing published link rather than a working link from the Documents area.
Verify the document’s Published status before distributing the link. A document that is not published may not be available to readers in the public documentation area.
Choose the correct audience before opening the document. The same project can organize published content into audience sections, and the public address reflects the audience path used to reach the document.
Test an important link after pasting it into its final destination. This is especially useful when linking from an email, a user guide, or an external knowledge base.
Use a descriptive document title so readers can recognize the document after they open the slug-based link. The slug identifies the page in the address, while the visible title helps readers confirm they reached the intended content.

Troubleshooting

The document does not appear in View Published Docs

Return to Documents and verify that the document is marked Published. Only documents available in the published documentation area can be opened and shared through a public document link.

The link opens the wrong documentation section

Open View Published Docs again and select the intended audience, such as User Guides, before opening the document. Copy the address only after you have opened the correct published page.

Recipients cannot find the document from the link

Confirm that you copied the entire browser address, not only the final document slug. The project, audience, and document slug portions work together to identify the published document.