This page explains how to review and publish the documentation generated for a project version in Atloria. Publishing makes the reviewed documentation available to readers through the published documentation experience.
Overview
Atloria organizes documentation around projects and their versions. Before you publish, you review the documentation associated with a selected version to make sure it is ready for readers. The review area includes a 1 Review Summary step and a Back to Review action, helping you return to the review process before publishing.
When a version is ready, use the 🚀 Publish Version 4 action shown for that version. After publication, Atloria marks the version as Published and provides 🌐 View Published Docs so you can open the reader-facing documentation.
This workflow is intended for publishing documentation that Atloria has prepared for a project version. The available interface evidence shows version review and publication controls; it does not show a separate manual page editor with fields such as a page title or page body. Review the generated documentation carefully before using the publish action.
📷 Screenshot pending: The Projects screen showing the project list and the Projects heading.
Prerequisites
Before you start, make sure you have:
- Access to the Projects area.
- A project that contains a version ready for review.
- Permission to publish the selected project version.
- Documentation content available in the project version’s review area.
- Time to verify the content before readers can access it.
Step-by-Step Instructions
-
Click Projects to open the list of projects available to you.
-
Select the project whose documentation you want to publish.
-
Open the project version that contains the documentation you want readers to see.
-
Open the version’s review area.
-
Select 1 Review Summary to review the version’s documentation summary.
-
Review the displayed documentation content for accuracy, completeness, and reader readiness.
-
Click Back to Review if you need to return from a later review or publication screen to the review workflow.
-
Complete any required review checks for the selected version.
-
Click 🚀 Publish Version 4 to publish the version shown in the current screen.
-
Confirm the publication when Atloria asks you to proceed.
-
Verify that the version is labeled Published after the publication completes.
-
Click 🌐 View Published Docs to open the documentation as your readers will see it.
📷 Screenshot pending: The version review screen with the 1 Review Summary section and the Back to Review action.
-
Read through the published documentation in the reader view.
-
Click 4. Published Docs Nav to check the navigation available to documentation readers.
-
Confirm that the published page is reachable from the reader-facing documentation navigation.
📷 Screenshot pending: The published documentation reader showing the Published status, reader navigation, and the View Published Docs action.
Tips and Best Practices
-
Review before publishing. The 🚀 Publish Version 4 action publishes a version, so use 1 Review Summary to verify the documentation before making it reader-facing.
-
Treat publication as a version milestone. After you publish, the version displays the Published status. Make sure you are working in the intended version rather than reviewing an earlier or incomplete version.
-
Check the reader experience after publishing. Clicking 🌐 View Published Docs is the fastest way to verify what documentation readers can access.
-
Use the published navigation as a final quality check. The 4. Published Docs Nav area helps you confirm that readers can move through the documentation as expected.
-
Return to review when needed. If you discover an issue while checking publication, use Back to Review to return to the review workflow rather than assuming the published reader view is the place to make changes.
-
Start from the project hub when managing multiple projects. The Projects screen provides a central place to find the correct project. You can also use Search projects... when the list is long.
Related Pages
- Projects
- Review a Project Version
- View Published Documentation
- Compare Project Versions
- Project Analytics
Troubleshooting
You cannot find the project to publish
Return to Projects and use Search projects... to locate the project. If the project is still unavailable, confirm that you have access to it or ask a project administrator to grant access.
The publish action is not available
Make sure you are viewing a version that is ready for review and publication. Return to 1 Review Summary and complete the required review process. If the version is already marked Published, you may be viewing a version that has already been released.
The published documentation does not look correct
Click 🌐 View Published Docs to confirm the reader-facing result, then select Back to Review to revisit the review workflow. Verify that you selected the intended project version before publishing.
Was this page helpful?