Skip to content
D
Documentation

Managing Reader Navigation in Published Documentation

12 min readUpdated

Opening Published Documentation and Understanding the Page Layout

When you open published documentation in Atloria, you are taken to a reader-facing documentation page rather than an editing workspace. The screen is organized around two main areas: a left-side navigation panel and a main document content area. The left side helps you move through the published documentation set, while the larger content area on the right shows the page you are currently reading.

Readers usually arrive in one of three ways:

  • By opening a published documentation link directly
  • By landing on a version-specific page link
  • By selecting a link from another published document page

No matter how you arrive, the layout gives you clues about where you are. The left-side navigation shows the broader documentation structure. The main content area shows the current page title and body content. The address bar shows the page path, which helps you confirm whether you are in the expected published documentation set and version.

This is different from the browsing approach described in Browsing Published Documentation and Finding the Right Page. In that guide, the focus is on locating content. Here, the focus is on understanding how the published page itself supports movement between pages once you are already inside the documentation.

Use the layout in two ways:

  • Browse through the navigation tree when you want to scan sections and move through the documentation in order
  • Open a page directly by link when you already know the exact document you need

If you open a direct page link, Atloria should still display the same published reading experience, with the navigation visible alongside the document content.

Moving Between Documents with the Side Navigation

The left-side navigation is the main tool readers use to move between published pages in Atloria. It shows the documentation structure as a list of sections and pages. Some items appear as top-level sections, while others appear nested underneath a parent item. This lets you see how topics are grouped before you open them.

When you scan the navigation, look for these patterns:

  • A single page item opens one document page
  • A parent item with child pages represents a section with multiple related documents
  • Expanded groups show the pages available inside that section
  • Collapsed groups hide child pages until you open them

If a group can be expanded or collapsed, changing its state affects only what you can see in the navigation list. It does not change the published content itself. Expanding a group helps when you want to compare nearby topics. Collapsing a group makes the navigation easier to scan when the documentation set is large.

As you move from page to page, Atloria should show your current location in the navigation. The open document should appear highlighted or otherwise visually marked so you can tell which page is active. This is especially helpful when several pages have similar titles or when you entered the documentation from a direct link instead of starting at the top of the structure.

When you select another page from the navigation:

  1. Click the page title in the left-side navigation.
  2. Wait for the main content area to update.
  3. Confirm that the newly opened page is now marked in the navigation.
  4. Keep using the same navigation panel to continue moving through related pages.

The key benefit is continuity: the document content changes, but the navigation context stays visible so you can keep your place in the published structure.

After you open a page from the left-side navigation, most of your time is spent in the main document content area. This is where Atloria displays the published page title and the full body of the document. Readers typically move through the page from top to bottom, then follow links to related topics as needed.

Links inside a document page are useful when the writer wants to guide readers to supporting material without making them return to the navigation panel first. In practice, you may see links that move you to another published document page covering a related task, a deeper explanation, or a follow-up topic. These links should keep you inside the same published documentation experience rather than sending you to a private editing view or another workspace.

As you read, use links in two ways:

  • Follow related-topic links when you need more detail before continuing
  • Use the side navigation again if you want to jump to a different section entirely

A good published reading flow in Atloria feels consistent. When you click a document-to-document link, the main content area should switch to the target page, and the left-side navigation should continue to reflect your current place in the documentation set. You should not lose the surrounding documentation context just because you followed a link in the page body.

If you manage published documentation, it is worth checking linked pages yourself. Open a few links from within published pages and confirm that they lead to the intended reader-facing page. The destination should display as a published document with the same navigation experience still available.

For related reading patterns, you can continue from this guide into Finding Content Through Public Documentation Structure, which focuses more on how the structure itself helps readers locate information.

Using Version-Aware Paths to Stay in the Right Documentation Version

In Atloria, published documentation may be available in more than one release version. When that happens, the page address helps identify which version you are reading. A version-aware path is the version-specific part of the published documentation link. Readers do not need to edit it, but they should know how to recognize it.

When you open a published page, check the address bar if you need to confirm version context. If the documentation is versioned, the page path should clearly keep you within that same release as you move between pages. This matters because two versions of the same documentation may contain different instructions, screenshots, or feature descriptions.

As you move from one page to another, Atloria should preserve the same version-aware path. If you start in one published version and click a page in the side navigation or a link inside the document body, the next page should remain in that version unless you intentionally switch to another release.

Check the URL in these situations:

  • You followed a link and the content looks different than expected
  • The page title is familiar, but the instructions do not match your release
  • You are comparing two releases and want to confirm which one is open
  • You are validating links before sharing them with readers

A quick version check usually involves comparing several pages in the same documentation set and making sure the version part of the address remains consistent. If one page opens under a different version path, readers may end up mixing instructions from different releases.

Version-aware paths are especially important for documentation managers. They help confirm that shared links, navigation items, and in-page links all point to the same published release, which keeps readers from landing in older or unintended documentation.

Checking That Navigation Matches the Published Structure

When you review published documentation in Atloria, it is important to confirm that the left-side navigation matches the structure readers are meant to see. This is less about editing content and more about validating the public reading experience page by page.

Start by opening the published documentation and scanning the full navigation tree. Expand any visible parent sections and click through several pages. Each item shown in the navigation should open a valid published document in the main content area. If a page appears in the navigation, readers should be able to open it without leaving the published documentation experience.

As you review, compare what appears in the navigation with what appears in the page itself:

  • The navigation label should clearly match the page readers open
  • The page title in the main content area should make sense in relation to the navigation label
  • Parent and child items should reflect the intended topic hierarchy
  • Pages grouped under one parent should feel like part of the same section

It is normal for a navigation label and a page title to differ slightly, but they should still be recognizable as the same topic. If the wording is too different, readers may think they opened the wrong page.

You should also check version consistency while reviewing structure. Open several pages from different parts of the navigation and confirm that their page addresses stay within the same published version. Then follow a few links inside the page body and make sure those links also stay in that version.

A practical review flow looks like this:

  1. Open the published documentation home or a known published page.
  2. Expand each visible section in the left-side navigation.
  3. Open several parent and child pages.
  4. Confirm the page title, navigation label, and page address all align.
  5. Repeat the check in another section of the same published version.

Fixing Common Navigation Problems Readers Encounter

Reader navigation issues in Atloria usually show up in a few recognizable ways. The good news is that you can often identify the cause by comparing the current page, the left-side navigation, and the page address.

If a page opens but the side navigation does not highlight the current document, first look at the page address. The published page may have opened from a link that does not match the navigation path readers normally use. In that case, the content may still load, but the navigation cannot clearly show where the page belongs. Reopen the page from the left-side navigation and compare the address with the original link.

If a link sends readers to the wrong version, inspect the address bar before and after clicking. The target page may be using an older or different version-aware path. This is especially noticeable when the content looks familiar but the instructions do not match the release you expected. Test the link again from the current published version and confirm that the version portion of the address stays consistent.

If a document is missing from the side navigation, the page may still exist as a direct link but not be included in the published structure readers browse. Open the page directly if you have the link, then compare it with the visible navigation tree. If readers cannot reach it from the navigation, it is not fully discoverable in the published documentation experience.

If navigation labels and page titles do not match, readers may hesitate because they cannot tell whether they are on the correct page. Review both the label shown in the left-side navigation and the title shown in the main content area. They should point to the same topic in plain, recognizable wording.

Use this quick comparison table when checking issues:

ProblemWhat to checkExpected result
Current page not highlightedPage address and navigation pathThe open page is visibly marked in the navigation
Wrong version opensVersion-aware part of the addressThe page stays in the same published version
Page missing from navigationVisible navigation tree versus direct page linkThe page appears in the published structure
Label and title mismatchNavigation label and page titleBoth clearly describe the same document

Overview

Managing reader navigation in published documentation means checking how people move through Atloria’s public reading experience after a page has already been published. The most important elements are the left-side navigation, the main document content area, and the page address in the browser. Together, these help readers understand where they are, what they are reading, and how to move to the next topic.

The left-side navigation shows the published structure of the documentation set. Readers use it to scan sections, open pages, and keep track of their current location. The main content area displays the selected document page and any links placed inside the page body. The browser address helps confirm whether the page belongs to the correct published version.

This guide focuses on managing that reading flow, not on creating pages or publishing them. If you need help locating pages before thinking about navigation behavior, refer back to Browsing Published Documentation and Finding the Right Page.

Keep these core navigation checks in mind:

  • Readers should be able to move between pages using the left-side navigation
  • The current page should remain clear in the navigation
  • Links inside a document page should keep readers inside the same published documentation experience
  • Version-aware paths should remain consistent as readers move across pages
  • Navigation labels, page titles, and page addresses should all point to the same published content

The next guide, Finding Content Through Public Documentation Structure, builds on this by focusing on how readers use the published structure itself to locate information efficiently.

Prerequisites

Before working through reader navigation checks in Atloria, make sure you have access to a published documentation page that opens in the public reading experience. You do not need the editing workspace for the tasks in this guide, but you do need a live published page or a shared published link that displays the left-side navigation and main document content area.

It helps if you already know how to browse within published documentation. If you have not done that yet, read Browsing Published Documentation and Finding the Right Page first. That guide explains how readers arrive at content and recognize the right page before they begin moving through the documentation structure.

Have these items ready:

  • A published documentation link in Atloria
  • Access to at least one documentation set that includes multiple pages
  • If available, a published version that uses version-aware paths
  • A few known document links to test from inside page content

You will get the most value from this guide if the published documentation includes:

  • Parent sections with child pages in the left-side navigation
  • Links inside document pages that point to other published pages
  • More than one page in the same published version so you can compare addresses

If you are reviewing navigation quality for your team, plan to open several pages rather than checking only one. Navigation issues often appear only when you move between sections, follow in-page links, or compare one page address with another.

Was this page helpful?

Download as PDF