Browsing Technical Documentation and Entity Reference Pages

Finding technical documentation from project and public views

In Atloria, you can browse technical documentation in two main places: inside a project workspace and in the published documentation view. The project workspace is where your team reviews draft content, generated reference pages, and technical sections that may not be public yet. The published view is the reader-facing version that shows only content included in the live documentation set. If you already know how API reference sections are organized, use Reading API Reference Sections in Technical Documentation as a companion while you browse.

Inside a project, start from the documentation area for that project and use the left navigation panel to move through the page tree. You may see section names, nested categories, and generated reference entries listed under technical documentation areas. In published documentation, the same content is usually reached from the public navigation menu, sidebar, or section landing page.

As you move through Atloria, pay attention to how you entered the content. A section page usually acts like a hub. It may contain an introduction, grouped links, or a list of related reference entries. An entity reference page is more structured. It typically focuses on one item and shows organized details such as fields, parameters, or related entities. A relationship link is different again: it takes you from one reference page directly to another linked item, such as a referenced type, related endpoint, or connected schema.

Project context matters because internal workspaces can include draft pages, newly generated reference entries, or links that only project members can open. In the public view, you only see pages that have been published. If a link works in the project workspace but not in public documentation, you are likely looking at content that has not been published yet.

Browsing sections, categories, and generated reference entries

When you open a technical documentation section in Atloria, begin with the left sidebar or the section index on the page. These areas help you understand the structure before you open individual entries. A section may contain child pages, grouped categories, or nested folders that separate conceptual content from generated reference content. If the section is large, scan the grouped headings first so you can jump directly to the part you need.

Many teams use a mix of written guidance and generated reference pages. In practice, that means you may start on a narrative page that explains a feature, then move into a structured reference entry by clicking a linked entity name inside the content. You might also enter through a section list that displays cards, grouped page names, or an index of technical items.

Common entry points into generated reference pages include:

• Linked names inside a technical article
• Entity cards shown in a section landing page
• Type or schema names listed in structured content
• Endpoint names shown in a reference index
• Related item links at the bottom or side of a page

As you browse, look for visual clues that tell you whether a page was written manually or generated from parsed project content. A manually authored page usually reads like a guide, with paragraphs, headings, and explanatory text. A generated reference page is more structured and often includes a title, a short description, metadata blocks, and field-style listings.

The table below shows the differences you are most likely to notice while browsing:

If you are unsure where to click next, open the section page first, then follow the linked entry that matches the exact item name you want to inspect.

Opening an entity detail page and reading its reference information

When you open an entity detail page in Atloria, the layout becomes more structured than a standard documentation page. At the top, you will usually see the entity title, followed by a short summary or description. Some pages also show an identifier or page label near the title area, which helps you confirm that you opened the correct reference entry.

Below the header, Atloria may show one or more structured sections. These sections are designed for quick scanning. Instead of reading the page from top to bottom like an article, start with the summary, then move to the tables or grouped reference blocks that describe the item in detail.

A field or property table often includes details like these:

Some entity pages also include signature-style details. In Atloria, these can appear as parameter lists, return information, inherited members, or request details such as method and path information on endpoint-style pages. If you are checking how one item connects to another, these structured blocks are often more useful than the summary text.

Related links are another important part of the page. Look around the main content area for linked parent items, child members, referenced schemas, or other technical concepts connected to the current page. These links help you move through the documentation without going back to the sidebar each time.

When a page includes several structured sections, read them in this order: summary first, then fields or parameters, then related links. That sequence makes it easier to understand both the item itself and how it fits into the wider reference set.

Following relationships between entities and reference pages

Relationship links are what turn technical documentation in Atloria from a collection of pages into a connected reference map. On one page, you might see a linked type in a field row. On another, you may find a related entity panel, a parent item link, or a usage section that points back to where the current item appears elsewhere. These links help you trace how documentation pieces connect.

A common browsing pattern starts on a section page, moves into a generated reference entry, and then follows one of its linked relationships. For example, you might open a reference page, review a field list, and click the linked type name in one row to open the referenced entity. In another case, you may open a detailed operation page and then use a related link to jump to the broader item that contains it.

To avoid losing your place, use the navigation aids already on the page:

• Breadcrumbs help you see the path back to the section or category.
• Previous/Next links help you move through nearby pages in sequence.
• Related content panels help you jump sideways to connected items.
• The left sidebar helps you return to the broader documentation tree.

These tools matter most when you are several clicks deep into linked reference pages. If you open one linked item after another, check the breadcrumb trail before continuing so you know whether you are still inside the same section or have moved into a different branch.

Relationship browsing can differ between project and public views. In a project workspace, Atloria may let you open draft-only or internal reference pages that are still being reviewed. In public documentation, some links may not appear, or they may stop at the last published page in the chain. That usually means one of the connected items is not part of the published set yet.

Understanding what changes between project previews and public documentation

Project previews and public documentation can look similar at first, but they serve different purposes in Atloria. The project preview is for internal review. It can include draft edits, newly generated technical reference pages, and links to items that are still being prepared. Public documentation is the published experience that readers see after release, so it only includes content that has been made available publicly.

When you compare the two views, start by checking the page context. In the project workspace, you are usually navigating from a project-specific sidebar, project home area, or internal documentation tree. In the public view, navigation is centered on the published documentation structure. Even when the page title matches, the available links around it may differ.

You can often tell which version you are viewing by looking for page-state clues such as:

One of the most important checks for technical writers and documentation managers is relationship completeness. A page may look correct in the project preview because all linked entities are available internally, but the public version may show fewer links if some connected entries were not published. That can make a relationship chain feel broken to readers.

Before publishing, open the same section in both contexts and compare the entity title, summary text, and related links. If a generated reference page includes structured details, confirm that those details appear consistently in the public version as well.

For more on public-facing reference reading, see Reading Published API and Technical Documentation and Using API Reference Pages in Published and Project Views.

Resolving common issues when browsing reference content

If reference browsing feels inconsistent in Atloria, the fastest fix is usually to confirm what view you are in and whether the linked content is available there. Most browsing issues come from differences between project-only content and published content, not from the page you are currently reading.

If a linked entity page does not open, first check whether you are in a public documentation view. The target page may exist in the project workspace but not be published yet. It may also have been removed from the current project content or no longer appear in the section where you expected it. Return to the sidebar or section index and search for the same title there. If it appears internally but not publicly, the issue is likely visibility rather than navigation.

If a reference page looks incomplete, compare it with the same page in the project workspace. Missing field details, relationship blocks, or structured sections can mean the generated reference content is not fully available in the version you are viewing. This is especially important after content updates or publishing changes.

Use this table to troubleshoot quickly:

If related entities are missing from a page, check whether both sides of the relationship are present in the same documentation set. A reference chain only works cleanly when the connected pages are all available in the view you are using. For admin-side checks on workspace visibility and review areas, you may also find Using the Admin Workspace helpful.

Overview

This guide focuses on how to move through technical documentation in Atloria once the reference content already exists. The main skill is recognizing where you are: a section landing page, a manually written documentation page, or a generated entity reference page. Each one supports a different reading pattern. Section pages help you enter a topic, authored pages explain concepts, and entity pages give you structured details.

You also learned how Atloria presents technical relationships. Instead of treating each page as isolated, use linked names, related content panels, breadcrumbs, and sidebar navigation together. That makes it easier to move from one reference entry to another without losing the section context. When you open an entity page, scan the title and summary first, then use the structured tables and related links to answer specific questions quickly.

Another key point is the difference between project and public views. Internal project browsing may include draft-only pages and relationship links that are not available publicly yet. Public documentation only shows what has been published, so missing links or shorter relationship chains are often expected if connected items are still internal.

If you need a refresher on reading reference sections before moving between linked pages, return to Reading API Reference Sections in Technical Documentation. If your next step is learning how to manage browsing more deliberately across these views, continue with Managing Technical Documentation Browsing and API Reading.

Prerequisites

Before using this guide, you should already be able to open documentation in Atloria and recognize the difference between project workspaces and published documentation. You do not need advanced technical knowledge, but you should be comfortable using the left navigation, opening pages from a documentation tree, and following links inside rendered documentation pages.

This guide is most useful if you already know how to read a reference section at a basic level. In particular, it helps to understand how section pages group content and how generated reference entries appear alongside authored documentation. If that part is still unfamiliar, read Reading API Reference Sections in Technical Documentation first.

You should also have access to at least one of these browsing contexts:

• A project workspace with technical documentation enabled
• A published documentation view that includes technical reference content
• A section that contains linked reference entries or entity detail pages

If you are working as a technical writer or documentation manager, it is helpful to have permission to compare project preview content with public documentation. That allows you to verify whether entity titles, summaries, and relationship links appear correctly before release. If you need help getting to the right workspace first, use Managing Technical Documentation Browsing Inside Projects or Using API Reference Pages in Published and Project Views.