This page explains how Atloria supports discovery of your published technical documentation through its documentation sitemap. Keeping your documentation published and accessible helps users and search tools find the latest approved content.
Overview
A documentation sitemap is a discovery aid for published documentation. It helps organize the public documentation pages that Atloria makes available through your published documentation area, including technical documentation and individual document pages.
You typically review sitemap availability after you have generated and published documentation. The sitemap is relevant when you want readers to discover your documentation from the published documentation navigation, when you are sharing documentation externally, or when you are validating that published content—not work in progress—is available to the public documentation experience.
In Atloria, the key control point is publication. Documentation must reach the Published state before it can be presented in the published documentation area and become available for discovery. Draft content remains separate from the public experience.
📷 Screenshot pending: The published documentation area showing the Technical Docs navigation and the View Published Docs action.
Prerequisites
Before you begin, make sure that:
- You can access the Atloria project or workspace that contains the documentation.
- You have documentation ready to publish, either generated in Atloria or imported through Or import existing documentation.
- Your documentation has been reviewed for accuracy, titles, and audience suitability.
- You have the required permission to publish documentation for the project.
- You know whether you are managing Technical Docs, user-facing documentation, or both.
- You have access to the public documentation view through View Published Docs.
Step-by-Step Instructions
-
Open the documentation area for your Atloria project.
-
Select Technical Docs to work with your project’s technical documentation.
-
Select Configure → if you need to complete the project’s documentation setup before publishing.
-
Select Generate Documentation → if the documentation you want to publish has not yet been generated.
-
Select Or import existing documentation if you are bringing previously written documentation into Atloria.
-
Review the documentation that Atloria has prepared for publication.
-
Confirm that each document intended for discovery is ready to be published.
-
Publish the documentation so that its status changes to Published.
-
Check the 3. Published Status area to confirm that publication has completed.
-
Select View Published Docs to open the public documentation experience.
-
Review the published documentation navigation to confirm that your technical documentation appears under the expected documentation section.
-
Select Technical in the published documentation navigation to verify that technical content is visible to readers.
-
Open a published document to confirm that its title and content are available in the public documentation experience.
-
Repeat the publication process whenever you add, revise, or regenerate documentation that should be discoverable.
📷 Screenshot pending: The Published status and View Published Docs action used to verify that documentation is available publicly.
Tips and Best Practices
-
Publish only finalized content. The sitemap supports discovery of published documentation, so review content before moving it into the Published state.
-
Use clear, distinct document titles. Readers use the published documentation navigation to locate content, and clear titles make technical topics easier to recognize.
-
Verify the public view after every significant documentation update. Select View Published Docs and check the published navigation rather than relying only on the authoring or configuration view.
-
Keep technical documentation organized separately from other documentation types. Atloria supports Technical Docs alongside other documentation, so confirm that readers can find the right material in the appropriate published section.
-
Treat publication as the discovery checkpoint. If a document is not visible through View Published Docs, it should not be considered ready for sitemap-based discovery.
-
Regenerate documentation when your underlying project changes. Select Generate Documentation → when you need Atloria to produce updated documentation, then review and publish the updated result.
-
Use Export Documentation when you need a copy of the published documentation for external review, archival, or distribution. Exporting does not replace checking the content in View Published Docs.
-
If your organization uses automated delivery practices, review Configure CI/CD and Authorize Atloria as part of your broader documentation publishing process. Ensure automated updates are reviewed before they are published for discovery.
Related Pages
- Generate Technical Documentation
- Import Existing Documentation
- Publish Documentation
- View Published Documentation
- Configure CI/CD for Documentation
- Export Documentation
Troubleshooting
Published documentation does not appear in the public view
Confirm that the documentation status is Published. Review the 3. Published Status area, then select View Published Docs again. Content that has not been published remains unavailable in the public documentation experience.
The Technical section does not contain the expected documents
Return to Technical Docs and verify that the documents were generated or imported into the correct documentation type. If needed, select Generate Documentation → or Or import existing documentation, then publish the resulting documentation.
Recent documentation changes are not visible
Regenerate the documentation if the project has changed, review the updated content, and publish it again. Then use View Published Docs to confirm that readers can see the current published version.
Was this page helpful?