Skip to content

Navigate the Atloria Interface

page
5 min readUpdated

This page explains how to move between your projects, documents, technical documentation, settings, and published documentation in Atloria. Knowing where each area is helps you find information quickly and keep your documentation work organized.

Overview

Atloria organizes your work around projects. The Projects area is your central hub for locating the project you want to work on, while Documents helps you browse and find documentation created for those projects. Use the available search fields when you know part of a project or document name and want to reach it faster.

Once you open a project, you can use Overview or 📊 Overview to orient yourself, and select Technical Docs when you need technical documentation. The Atloria Stack area provides another project-focused view that may be useful when reviewing the project’s technical context.

Settings are available through Settings and are organized into General Settings, Parser Settings, and Template Settings. These areas let you review the configuration that affects how Atloria processes and presents your documentation.

When documentation is ready to share, select View Your Documentation → to open the public-facing documentation experience. Public documentation can be organized by project and audience, allowing readers to navigate the documentation intended for them.

📷 Screenshot pending: Project navigation showing the Projects hub, search field, and project-level documentation options.

Prerequisites

Before you begin, make sure that:

  • You are signed in to Atloria.
  • You have access to at least one project, or have been invited to one.
  • You know the name of the project or document you want to find, if you plan to use search.
  • You have the appropriate permissions to view project settings or technical documentation.
  • You have a project with published documentation if you want to use View Your Documentation →.

Step-by-Step Instructions

  1. Open the Projects hub.

    Select Projects to view the list of projects available to you. You may also see this area identified as 1. Hub: All Projects, which indicates that it is the main starting point for browsing your work.

    The Projects hub is the best place to start when you need to switch from one project to another or when you are unsure where a document belongs.

  2. Find a project by browsing or searching.

    Review the available projects, or use the Search projects... field to narrow the list.

    Enter a recognizable word from the project name. As you refine your search, use the displayed results to select the project you need. If you need information that may span more than one project, use Search across all projects... instead.

  3. Return to the project list when needed.

    When you are viewing a specific project, select ← Back to Projects to return to the Projects hub.

    Use this control rather than relying on repeated browser navigation when you want to return to the complete project list and choose a different project.

  4. Open the project overview.

    Within a project, select Overview or 📊 Overview to see the project’s primary summary view.

    Start in the overview when you are learning a project or need a high-level orientation before opening its documentation. The overview gives you a consistent point of reference as you move between project areas.

  5. View technical documentation.

    Select Technical Docs to open technical documentation associated with the current project.

    Use this area when you need material intended to explain the technical structure or behavior of the project. If Atloria Stack is available, select it when you want to review that project-focused technical view.

  6. Browse or search documents.

    Select Documents to work with the documentation available to you. To locate a particular item, enter keywords in Search documents....

    Searching is especially useful when a project contains many documents or when you know the document title but do not remember its location. Open the matching document from the results to read it.

  7. Open Settings.

    Select Settings when you need to review or update configuration options. Settings may be presented as a numbered sequence:

    • 1. General Settings
    • 2. Parser Settings
    • 3. Template Settings

    You may also see General Settings as a direct option. Start there for general configuration. Use Parser Settings for options related to how project content is processed, and use Template Settings for options that affect documentation templates and presentation.

  8. Open public documentation.

    Select View Your Documentation → to open the public documentation for a project.

    In the public documentation area, readers can move through content organized for a project and, where available, select the appropriate audience and document. This is the view to use when you want to confirm what external or public readers will see.

📷 Screenshot pending: Settings options and the View Your Documentation button used to open public documentation.

Tips and Best Practices

  • Start with Projects when changing context. The Projects hub is the clearest place to move between projects. Use ← Back to Projects before selecting another project rather than searching through unrelated document views.

  • Choose the right search field. Use Search projects... to locate a project, Search documents... to locate documentation, and Search across all projects... when the information might exist in any project you can access.

  • Use Overview before drilling into details. Select Overview or 📊 Overview first when you are unfamiliar with a project. This helps you confirm that you are in the correct project before opening Technical Docs, Documents, or Settings.

  • Keep configuration tasks separate from reading tasks. Use Documents and Technical Docs to find and read content. Use Settings only when you need to manage the project’s configuration, including parser- or template-related options.

  • Verify published content from the public view. Select View Your Documentation → when you need to check the documentation experience intended for readers. This is useful after documentation changes or when sharing documentation with others.

Troubleshooting

I cannot find a project

Open Projects and use Search projects.... If the project does not appear, try Search across all projects.... If it is still unavailable, you may not have access to that project; contact the project owner or administrator.

I found the project, but not the document

Select Documents and search using Search documents.... Try a distinctive word from the title rather than the complete title. If you are looking for technical material, check Technical Docs as well.

I cannot see or change Settings

Select Settings and review the available options, such as General Settings, Parser Settings, and Template Settings. If the settings you need are not displayed or cannot be changed, your account may not have the required project permissions.

View Your Documentation does not show the content I expected

Use View Your Documentation → from the relevant project, then confirm that you selected the correct project and audience. Return to Documents or Technical Docs to verify that you are working with the intended documentation content.

Was this page helpful?

Download as PDF
Navigate the Atloria Interface — Atloria (self dogfood)