Exploring Technical Documentation Inside a Project

Opening the technical documentation area from a project

From your project workspace in Atloria, open the current project and use the project navigation to enter its technical documentation area. This section belongs to the project you are already viewing, so the pages you open here reflect only that project’s generated reference content. If you switch to a different project first, the technical documentation area will show that other project’s API and reference pages instead.

When the technical documentation area opens, look for the main landing content on the page. You will typically see a project documentation overview, along with navigation options that lead deeper into generated reference sections such as API documentation and entity reference pages. These links help you move from a high-level view of what has been generated into more detailed technical pages without leaving the project.

This project-level entry point is useful when you want to confirm what technical documentation exists for the current project before reviewing details. It keeps your work grounded in the same project context you used on the project home and related project screens covered in Managing Project Administration from the Project Home.

As you enter this area, expect access to depend on your role in the project or organization. In practice, Documentation Managers, Project Administrators, and Technical Writers are the people most likely to use this section because it supports documentation review and technical content validation. If the project opens normally but this area is not available, your access may be limited to other project screens.

Using the project documentation overview page

The project documentation overview page is the starting point for generated technical content inside a project. Use it when you want a quick picture of what Atloria has already produced for this project before opening detailed reference pages. Instead of dropping you directly into a single endpoint or entity page, the overview helps you understand the available documentation areas at a glance.

On this page, look for sections, links, or cards that point to the project’s API documentation and entity-specific reference pages. These entry points act like a table of contents for the project’s technical material. If you are checking coverage, this is usually the best place to begin because it shows which parts of the project’s technical documentation are available and ready to inspect.

The overview is especially helpful when you are comparing what should exist in the project with what has actually been generated. A Technical Writer might use it to decide where to start reviewing. A Project Administrator might use it to confirm that the project contains the expected technical sections before sharing the workspace with others. A Documentation Manager might use it to spot missing areas quickly.

As you move into deeper pages, keep the overview in mind as your return point. If you open an API page or an entity page and want to reorient yourself, use the project documentation navigation to go back to the overview. Returning there is the easiest way to switch from one reference area to another without losing track of the current project.

Browsing generated API documentation

To open the project’s API documentation, start from the project documentation overview and select the API link, card, or navigation item. This takes you into the generated API reference for the current project. Because this area stays inside the same project workspace, the API pages you see are tied to that project rather than to your organization as a whole.

Within the API section, generated pages are organized so you can browse the project’s available operations in a structured way. Depending on the project content, you may see the reference grouped by endpoint areas, operations, or related sections of the API. This layout helps you scan the available material instead of opening pages one by one without context.

On an API reference page, focus on the details that help you understand how the endpoint behaves. Typical items to inspect include:

• Endpoint path
• Supported methods
• Request details
• Response details
• Related generated reference information shown on the page

These pages are useful when you need to confirm what the generated technical documentation says about a specific API operation. A writer may review the request and response sections before drafting user-facing guidance. An administrator may use the same page to verify that the project’s generated reference looks complete.

When you want to move around, use the in-page navigation and project documentation links. You can go back to the project documentation overview to choose another section, or move across to a related entity reference page if you need to inspect the underlying project structure connected to what you are reading in the API documentation.

Exploring entity-specific reference pages

Entity-specific reference pages let you inspect the project’s generated documentation for a particular project-defined resource. You can reach one of these pages either from the project documentation overview or by following a related link from the API documentation area. This is helpful when an API page points you toward a specific entity and you want to understand that item in more detail.

On an entity page, look for the main reference details presented for that item. These pages typically show information such as:

• The entity name
• Its fields
• Its relationships
• Other generated technical details included for that entity

This view is useful because it gathers the project’s structural information into a single page inside the documentation area. A Technical Writer can use it to understand what fields should be described in supporting documentation. A Project Administrator can use it to confirm that the generated reference reflects the project structure they expect to see. In both cases, the work stays inside the project’s documentation section, so there is no need to jump out to unrelated project screens.

As you review one entity page, use the project documentation navigation controls to move to another. This may be through links in the surrounding navigation, links on the page itself, or a return to the overview before selecting a different entity. That makes it easier to compare related entities and check whether the generated reference is complete across the project.

Moving between overview, API, and entity pages efficiently

Inside a project, the main browsing flow is straightforward: project documentation overview → API reference → entity-specific reference pages. In Atloria, this flow works best when you treat the overview as your home base, then move into API or entity pages only when you need more detail. That approach helps you stay oriented, especially in projects with a larger amount of generated technical content.

Several navigation elements can help you keep your place while moving between sections:

• Sidebar links for switching between documentation areas
• Breadcrumbs that show where the current page sits inside the project
• Page headers that confirm whether you are in the overview, API, or an entity page
• Back-to-overview actions or equivalent navigation links

Different roles often browse in different patterns. Common examples include:

• Documentation Managers starting on the overview to check what technical coverage exists for the project
• Technical Writers opening API reference pages to inspect endpoint paths, methods, requests, and responses
• Project Administrators using entity pages to validate fields and relationships for project structures

The important point is that the project context stays preserved while you move. If you entered technical documentation from a specific project, the overview, API pages, and entity pages all remain tied to that same project. You do not need to reselect the project each time you switch sections. If you feel lost, return to the overview and continue from there.

This browsing pattern also prepares you for the workspace-level navigation covered next in Managing Project Workspaces and Recent Activity.

Fixing common problems when technical documentation pages are missing or incomplete

If the technical documentation entry point does not appear in the project navigation, first confirm that you are inside the correct project workspace. Since this area is project-specific, opening a different project may show different documentation options. If the project is correct and the navigation item is still missing, your role may not include access to the project’s generated technical documentation.

If the overview page opens but the API or entity reference sections are empty, treat that as a content availability issue rather than a navigation problem. The overview may be available even when detailed generated reference content has not been produced or is not currently visible for that project. In that case, compare what you expected to see with what is actually listed on the overview page.

When links between the overview, API, and entity pages do not match the project you expected, check that you started from the right project before entering the technical documentation area. Because Atloria scopes this content to the current project, the most common reason for unexpected reference content is that you are browsing inside a different project than intended.

If you can open the project itself but not the generated technical documentation area, the issue is usually related to access rather than the project being unavailable. This can affect users who can work in some project screens but do not have permission to open technical reference content.

Useful checks include:

• Confirm the current project name before opening technical documentation
• Return to the project documentation overview to verify what sections are available
• Use project navigation instead of browser history when switching between sections
• If access still seems limited, compare your available options with those used by Documentation Managers, Project Administrators, or Technical Writers

Overview

Use the project’s technical documentation area when you need to review generated reference content without leaving the current project workspace. In Atloria, this area is designed for browsing technical material that belongs to one project at a time, which makes it easier to validate coverage and inspect details in context.

The main parts you work with are:

• The project documentation overview as the starting page
• The API documentation section for generated endpoint and operation details
• The entity reference pages for project-specific structures, fields, and relationships

A practical way to use these pages is to begin on the overview, confirm what has been generated, then open the API or entity sections based on what you need to review. If you are checking high-level coverage, stay on the overview longer. If you need field-level or request-level detail, move into the deeper reference pages.

Keep these points in mind while browsing:

• The content is scoped to the current project
• Navigation inside the documentation area helps you move between overview and detailed pages
• Returning to the overview is the easiest way to reorient yourself
• Access to these pages may differ by project role

If you need more detail on reading technical reference content itself, continue with related guides such as Reading API and Technical Reference Pages and Understanding Entity Detail Pages in Technical Documentation.

Prerequisites

Before using the project’s technical documentation area in Atloria, make sure you already know how to open and work inside a project workspace. This guide assumes you can reach the correct project and use its main navigation. If you need help with that first, review Working with Project Lists and Dashboards and Managing Project Administration from the Project Home.

You should also have the right kind of access for the project. This guide is most relevant for users working in roles such as:

• Documentation Managers
• Project Administrators
• Technical Writers

These users are the most likely to see and use generated technical documentation inside a project. If your project workspace opens but the technical documentation area is not available, your current permissions may not include it.

To follow the tasks in this guide successfully, you should be able to:

• Open the intended project workspace
• Use the project navigation to find documentation-related sections
• Recognize the overview, API, and entity areas once they appear
• Stay within the same project while moving between technical pages

It also helps if the project already contains generated technical documentation. If the overview page appears but detailed sections are empty, the project may not yet have visible API or entity reference content to browse.

The next guide in this sequence is Managing Project Workspaces and Recent Activity, which builds on this project-level navigation and shows how to move through the wider workspace more confidently.