Skip to content

What can you do with Atloria

concept
6 min readUpdated

What you can do in Atloria

Atloria's main workspace helps you create projects, generate documentation, organize documents, and monitor documentation work. Use the dashboard for a quick starting point, Projects for project work, Documents for document organization, and Operations for activity and job information.

If you need to…Start here
Create a project or start documentation generationThe dashboard or Projects
Find, filter, categorize, or reorder documentsDocuments
Review generation, AI, credits, chat, jobs, or queuesOperations

Before you start

You need an authenticated workspace session for the dashboard data and document loading. Documents also require a selected project. If you are creating a project, prepare a repository URL when you want Atloria to read a repository, or use Create without a repository when you want to begin without one.

The project wizard lets you choose documentation outputs. The available choices are:

OutputUse it for
User GuidesStep-by-step guides, tutorials, and screenshots
Technical DocsComponent trees, entity graphs, and architecture diagrams
API ReferenceOpenAPI specifications, endpoints, and request/response examples
Support BotNot available for selection; it is marked Soon

Project creation also depends on the project name, slug, and branch being available before you continue from project details. Private repository access can require the Authentication path before the configuration path is available.

Find the workspace task

Use the following workspace destinations to reach the work you want to do:

If you want to…Open
Start at the workspace dashboardDashboard
Work with the project listProjects
Work with documents and categoriesDocuments
Review operational informationOperations

Choose a starting point

Prerequisites

  • You know whether you are creating a project, organizing documents, or reviewing activity.

Steps

  1. Choose one starting point from the table below.

    Your taskAction
    Start from recent projects or the project wizardOpen the dashboard
    Open the complete project listSelect View all from the dashboard when it is available
    Open a particular projectSelect Open for the project you want to open.
    Open the project list directlyOpen Projects
    Open document workOpen Documents
    Review operational informationOpen Operations

Result: The workspace surface for your task is on screen.

Understand the workspace surfaces

The dashboard presents recent projects with the headers Project, Docs, Categories, and Updated. Projects provides project search, status filtering, sorting, project counts, source, document and category counts, status, and update information. Documents provides a version choice, a category tree, and the document list. Operations presents generation success, AI spend, credits, deflection rate, attention lists, AI usage by model, recent jobs, and queues.

Use the surface that answers the question you have:

QuestionSurface to use
Which projects are available and when were they updated?The Projects list
Which documents belong to a category or version?Documents
How are generation jobs and recent activity performing?Operations

Create and organize documentation work

Start project creation or documentation generation

Prerequisites

  • You have a repository URL, or you intend to create without a repository.
  • You have chosen at least one enabled documentation output before generation.

Steps

  1. Choose how to start the project.

    Starting conditionAction
    You are starting without a repositorySelect Create without a repository
    You have entered a valid repository URLSelect Get Started →
  2. Choose the documentation outputs.

    Your choiceAction
    Every enabled outputSelect Select All
    Specific enabled outputsSelect each output you want
  3. Select Generate Documentation → after choosing at least one output.

Result: Atloria starts project creation and the selected documentation work.

Filter and sort projects

Prerequisites

  • Projects are available in the project list.

Steps

  1. Enter text in Search projects… to filter by project name or description.
  2. Choose All statuses, Active, Draft, Published, or Archived to filter by status.
  3. Choose Last updated, Name A–Z, Name Z–A, or Date created to change the order.

Result: The project list shows the projects that match the search, status, and sort choices.

Change document order

Prerequisites

  • A project is selected for document work.

Steps

  1. Select Edit order to enter document-ordering mode.
  2. Drag documents or categories to the required position.
  3. Select Exit edit mode when the order is complete.

Result: Documents are shown in the selected order.

Clear the category filter

Prerequisites

  • A category filter is selected in Documents.

Steps

  1. Select Clear to remove the selected category filter.

Result: The selected category filter is cleared.

Draft from an insight

Prerequisites

  • A manual insight with a Draft page action is available.

Steps

  1. Select Draft page beside the manual insight.

Result: The selected drafting route is on screen.

Choose the right branch

The available path changes with your access and current workspace data. Use these rules before you continue:

Prerequisites

  • You have access to the workspace and can identify the condition that applies.

Steps

  1. Choose the situation that matches your workspace.
SituationWhat to do
You need private repository accessUse Authentication, then continue through Configuration after access is resolved
You have no project selectedSelect a project before working with documents
No versions existContinue with the document list without a version choice
The project list is emptyUse the empty-state New project action
No projects exist for manual insightsContinue with the other Operations information
You want the unavailable outputChoose an enabled output instead of Support Bot

Result: You are on the path supported by your access, project, version, and output choices.

When a workspace action fails

Use the exact message on screen to choose the next action.

Prerequisites

  • A workspace action has displayed one of the messages in the table.

Steps

  1. Choose the matching message and follow its action in the table.
What you seeWhat to do
Please enter a valid GitHub, GitLab, or Bitbucket repository URLCorrect the repository URL before selecting Get Started → again.
Could not access repositoryCheck the repository access details and test the connection again.
Connection test failed — check your credentialsCheck the credentials before testing the connection again.
Failed to create configReview the project setup and retry project creation.
Failed to create projectReview the project setup and retry project creation.
Projects failed to load.Retry loading the Projects page.
Name doesn't matchEnter the exact project name in the deletion confirmation field.
This action is permanent and cannot be undoneContinue only when permanent deletion is intended.
Failed to delete categoryRetry the category deletion.
Failed to reorder documents. Please try again.Retry document ordering.
Failed to reorder categories. Please try again.Retry category ordering.
Operations failed to load.Retry loading the Operations page.
Insights failed to load.Retry loading manual insights.

Result: You have the recovery action that matches the message on screen.

Continue to the dedicated task

Use the focused page for the next task:

Prerequisites

  • You have chosen the task you want to complete next.

Steps

  1. Choose the focused page for the task you want to complete.
Next taskPage
Create a complete projectCreate a project
Understand project organizationProjects overview
Work with the document listDocuments overview
Create or edit a documentCreate and edit a document
Review operational informationOperations overview
Follow generation stagesDocumentation generation lifecycle
Interpret job statusDocumentation job status reference
Move between workspace destinationsNavigation basics

Result: You have chosen the dedicated task page for the work you want to complete next.

Was this page helpful?

Download as PDF
What can you do with Atloria — Atloria (self dogfood)