Skip to content

What is Atloria

concept
5 min readUpdated

What Atloria is

Atloria reads a repository and turns it into a customer-facing set of documentation and support surfaces. The product describes these surfaces as a knowledge base, user manuals, an API explorer, and AI support. Together, they give readers searchable help, step-by-step guidance, API details, and cited answers.

A public trial is the no-signup route for submitting a repository URL. An authenticated workspace is the signed-in area where you manage projects and start project setup.

Identify the home page entry points and the four customer touchpoints

Use this page to choose how to begin:

If you need to…Go to
Try documentation generation with a public repositoryStart with a public repository
Sign in with an email address and passwordSign in and reach the workspace
Use an organization's single sign-on routeSign in and reach the workspace
Choose a repository provider or continue without oneChoose a repository path in the workspace
Continue after reaching the dashboardWhat to do next
Learn what you can do after setupWhat can you do with Atloria

Before you enter the workspace

The dashboard is the authenticated workspace. The first-project wizard is its starting point for connecting code to a project. A repository provider is GitHub, GitLab, or Bitbucket. Single sign-on is the organization route that uses a work email or organization ID.

Prepare one of these starting points:

Starting pointWhat to have ready
Public trialA repository URL, or an example repository to select
Email sign-inYour email address and password
Single sign-onYour work email or organization ID
First-project wizardA repository URL, a connected provider, or a decision to create without a repository

The dashboard fetches projects and contains the onboarding checklist and first-project wizard. After a successful sign-in, Atloria routes you to /app and refreshes the page.

Choose how to start

From the home page, choose the route that matches your goal.

If you want to…Select
Try a public repositoryTry it free
Open the sign-in pageLogin
Begin a free account routeStart free →
Use the product-purpose linksProduct or Groundedness

The home page also displays Pricing and live product summaries, including repos connected, docs generated, languages and frameworks, citation validity, and manual quality. Its repository prompt begins with github.com/ and sits beside Generate docs.

Start with a public repository

The public trial lets you submit a repository URL without signing up. The repository field accepts a URL, and the page also offers example repositories that fill the field when selected.

Prerequisites

  • Have a public repository URL ready, or choose one of the displayed examples.

Steps

  1. Open Try it free from the home page.
  2. Enter the URL in Repository URL.
  3. Select Generate docs.
  4. When generation completes, select Open your docs hub → to open the generated hub.
  5. Select Copy link when you need the hub address on your clipboard.

Result: Atloria starts documentation generation for the repository; after completion, the page offers Open your docs hub → and Copy link.

If the request fails, the page displays the returned error message or HTTP status. During a failed generation, the page displays the generation error returned by the job: “Generation failed: {status.job.error}”.

Sign in and reach the workspace

The sign-in page is the route for an existing account or an organization that uses single sign-on.

Prerequisites

  • Have your email address and password, or your work email or organization ID for SSO.

Steps

  1. Open Login from the home page.

  2. Enter your email address in Email address.

  3. Enter your password in Password.

  4. Select Sign in.

  5. Choose one sign-in route:

    If you want to…Actions
    Sign in with an email address and passwordSelect Sign in.
    Use your organization's single sign-onSelect Continue with SSO. Enter your details in Work email or organization ID. Select Continue with SSO again.

Result: A successful credentials sign-in routes you to /app and refreshes the workspace.

The sign-in page also provides Sign up for a new account and Forgot your password? for password recovery.

Choose a repository path in the workspace

The first-project wizard is the workspace starting point for connecting code to an Atloria project. It offers separate routes for a valid repository URL, a connected provider, and a project without a repository.

Prerequisites

  • Reach the authenticated workspace.

Steps

  1. In the first-project wizard, choose one route:

    If you want to…Select
    Enter a repository URLEnter the URL, then select Get Started →
    Browse a connected providerSelect GitHub, GitLab, or Bitbucket
    Create a project without code connected yetSelect Create without a repository
  2. In repository browsing, search with Search repositories... when you need to narrow the list.

Result: The wizard proceeds with the selected repository route or starts a project without a repository. A valid detected provider allows Get Started → to proceed. A connected provider opens repository browsing; a provider that is not connected opens provider connection first.

When entry or generation fails

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

What you seeWhat to do
Invalid email or passwordCheck Email address and Password, then select Sign in again.
No SSO connection was found for that email. Check with your administrator.Check the work email or organization ID, or contact your administrator.
Could not start SSO. Please try again.Select Continue with SSO again.
Your organization requires single sign-on. Continue with SSO below.Use the SSO field and select Continue with SSO.
Single sign-on could not be completed.Return to sign-in and retry the SSO route.
Please enter a valid GitHub, GitLab, or Bitbucket repository URLCorrect the repository URL, then select Get Started →.
Failed to load repositories. Please try again.Retry repository browsing.
Failed to create projectThe page displays the project-creation error returned by the request.
A returned HTTP statusThe page displays the returned generation error.
A generation errorRead the generation error and correct the reported problem.

What to do next

After you choose an entry route, continue with the page that matches your next task:

Next taskContinue with
Complete account accessYour first day
Learn the dashboard shellUnderstanding the interface
Move between workspace destinationsNavigation basics
Create the first projectCreate a project
Explore the product capabilitiesWhat can you do with Atloria
Check access and environment needsSystem requirements
Find general error guidanceGeneral error messages

The dashboard is titled Dashboard and can include project, generation, and chat-answer activity summaries. It can also display Get started with Atloria, including Connect a repo and Dismiss get started checklist.

Was this page helpful?

Download as PDF
What is Atloria — Atloria (self dogfood)