This page explains how a documentation version ID identifies the specific version you publish. Using the correct version ID helps you open, review, publish, and share the intended documentation version without confusing it with another draft or generated version.
Overview
Documentation can exist in multiple versions for the same project. The version ID is the identifier associated with one specific version in the Versions area. It distinguishes that version from all other versions, including earlier published versions and newly generated versions.
You typically use a version ID when you need to work with a particular version rather than the project’s documentation in general. For example, you may open one version for review, verify its screenshots, publish it, or return to it later through the Version Manager.
After you publish a version, its status changes to Published. The published version is the one shown when you select View Published Docs. If you publish a newer version later, ensure you are working with that version’s ID and review context before selecting the publish action.
📷 Screenshot pending: The Versions screen showing multiple documentation versions and their individual status.
Prerequisites
Before you begin, make sure that:
- You can access the project whose documentation you want to publish.
- A documentation version has already been created and is listed in Versions.
- You know which version you intend to publish, such as the version labeled Version 4.
- The version’s content has been reviewed and is ready for publication.
- You have access to the Review & Publish area.
- Any required project branding or publishing settings have been completed.
Step-by-Step Instructions
-
Open the project that contains the documentation version you want to publish.
-
Select Versions to open the project’s Version Manager.
-
Locate the documentation version you want to work with in the version list.
-
Confirm the version’s identifying details so that you are selecting the intended version ID rather than another available version.
-
Select the version to open its version-specific workspace.
-
Select Review & Publish to review the selected version before publication.
-
Review the documentation content shown for the selected version ID.
-
Select the screenshots area if you need to confirm that the version contains the correct visual evidence.
-
Return to Review & Publish after completing your review.
-
Select 🚀 Publish Version 4 when Version 4 is the version you intend to make public.
-
Confirm the publication when the application asks you to proceed.
-
Check that the version status is displayed as Published.
-
Select 🌐 View Published Docs to open the documentation that is publicly available for the published version.
📷 Screenshot pending: The Review & Publish screen with the selected version context and the Publish Version action.
Tips and Best Practices
-
Work from Versions whenever you need to distinguish between multiple documentation versions. This is the central place to choose the version that corresponds to the ID you intend to publish.
-
Verify the selected version before clicking 🚀 Publish Version 4. The button label identifies the version being published, so do not use it until you have confirmed that the displayed version is the correct one.
-
Use Review & Publish as your final checkpoint. Review the content in the context of the selected version, rather than assuming that content from a different version will be included.
-
Use the screenshots area to validate version-specific images before publishing. Screenshots can differ between versions, especially after documentation is regenerated or updated.
-
After publication, use 🌐 View Published Docs to confirm the reader-facing result. This helps you verify that the version marked Published is available as expected.
-
If a newer documentation version is available, do not assume it replaces an earlier version automatically. Open the new version from Versions, review its version context, and publish it deliberately.
-
If you need to stop making a published version available, use Unpublish. Confirm that you are acting on the correct published version before removing it from public view.
Related Pages
- Manage Documentation Versions — Create, view, and organize documentation versions from Versions.
- Review Documentation Before Publishing — Use Review & Publish to validate content before release.
- View Published Documentation — Open reader-facing documentation with View Published Docs.
- Unpublish Documentation — Remove a currently Published version from public availability.
- Configure Publishing and Branding — Prepare documentation presentation and publishing settings.
Troubleshooting
I cannot tell which version I am about to publish
Return to Versions and select the intended version again. Then open Review & Publish and verify that the page is showing the expected version context before selecting 🚀 Publish Version 4.
The version does not show as Published
Refresh the version list and check the version’s status. If it is not marked Published, return to Review & Publish for that same version and complete the publish confirmation. Also confirm that you selected the publish action for the intended version.
View Published Docs does not show the documentation I expected
Go back to Versions and check which version is marked Published. If a different version was published, open the correct version by its version ID, review it, and publish that version.
Was this page helpful?