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 generation | The dashboard or Projects |
| Find, filter, categorize, or reorder documents | Documents |
| Review generation, AI, credits, chat, jobs, or queues | Operations |
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:
| Output | Use it for |
|---|---|
| User Guides | Step-by-step guides, tutorials, and screenshots |
| Technical Docs | Component trees, entity graphs, and architecture diagrams |
| API Reference | OpenAPI specifications, endpoints, and request/response examples |
| Support Bot | Not 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 dashboard | Dashboard |
| Work with the project list | Projects |
| Work with documents and categories | Documents |
| Review operational information | Operations |
Choose a starting point
Prerequisites
- You know whether you are creating a project, organizing documents, or reviewing activity.
Steps
-
Choose one starting point from the table below.
Your task Action Start from recent projects or the project wizard Open the dashboard Open the complete project list Select View all from the dashboard when it is available Open a particular project Select Open for the project you want to open. Open the project list directly Open Projects Open document work Open Documents Review operational information Open 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:
| Question | Surface 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
-
Choose how to start the project.
Starting condition Action You are starting without a repository Select Create without a repository You have entered a valid repository URL Select Get Started → -
Choose the documentation outputs.
Your choice Action Every enabled output Select Select All Specific enabled outputs Select each output you want -
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
- Enter text in Search projects… to filter by project name or description.
- Choose All statuses, Active, Draft, Published, or Archived to filter by status.
- 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
- Select Edit order to enter document-ordering mode.
- Drag documents or categories to the required position.
- 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
- 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
- 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
- Choose the situation that matches your workspace.
| Situation | What to do |
|---|---|
| You need private repository access | Use Authentication, then continue through Configuration after access is resolved |
| You have no project selected | Select a project before working with documents |
| No versions exist | Continue with the document list without a version choice |
| The project list is empty | Use the empty-state New project action |
| No projects exist for manual insights | Continue with the other Operations information |
| You want the unavailable output | Choose 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
- Choose the matching message and follow its action in the table.
| What you see | What to do |
|---|---|
Please enter a valid GitHub, GitLab, or Bitbucket repository URL | Correct the repository URL before selecting Get Started → again. |
Could not access repository | Check the repository access details and test the connection again. |
Connection test failed — check your credentials | Check the credentials before testing the connection again. |
Failed to create config | Review the project setup and retry project creation. |
Failed to create project | Review the project setup and retry project creation. |
Projects failed to load. | Retry loading the Projects page. |
Name doesn't match | Enter the exact project name in the deletion confirmation field. |
This action is permanent and cannot be undone | Continue only when permanent deletion is intended. |
Failed to delete category | Retry 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
- Choose the focused page for the task you want to complete.
| Next task | Page |
|---|---|
| Create a complete project | Create a project |
| Understand project organization | Projects overview |
| Work with the document list | Documents overview |
| Create or edit a document | Create and edit a document |
| Review operational information | Operations overview |
| Follow generation stages | Documentation generation lifecycle |
| Interpret job status | Documentation job status reference |
| Move between workspace destinations | Navigation basics |
Result: You have chosen the dedicated task page for the work you want to complete next.
Was this page helpful?