Create a project to organize documentation for a product, service, codebase, or knowledge domain. Your project becomes the focused workspace where you can review documentation, changes, versions, screenshots, and project analytics.
Overview
Atloria uses projects to keep documentation work separated by subject. For example, you can create one project for a customer-facing product, another for an internal service, and another for a codebase that needs technical documentation.
The Projects area is your hub for viewing and managing all available projects. From there, you can search for an existing project, open a focused project workspace, or start a new one using New Project.
When your project is connected to source material, Atloria supports repository-based workflows. The new-project experience includes options associated with GitHub, GitLab, and Bitbucket, helping you begin with the source that best represents the product or codebase you want to document.
📷 Screenshot pending: The Projects hub showing the project list, the Search projects field, and the New Project button.
Prerequisites
Before you begin, make sure you have the following:
- Access to the Projects area in Atloria.
- A clear name or purpose for the project, such as a product name, service name, or knowledge domain.
- The location of the documentation source you want to use, if applicable.
- Access to the relevant repository if you plan to use GitHub, GitLab, or Bitbucket.
- Permission to create a project in your Atloria workspace.
Step-by-Step Instructions
-
Open Projects from the Atloria application.
-
Review the existing project list to confirm that a project for your product, service, codebase, or knowledge domain does not already exist.
-
Use Search projects... to look for a project by name when the list contains multiple projects.
-
Select New Project to begin creating a project.
📷 Screenshot pending: The New Project entry point in the Projects hub.
-
Choose the source option that matches the material you want to document.
-
Select the GitHub option if your documentation source is stored in GitHub.
-
Select the GitLab option if your documentation source is stored in GitLab.
-
Select the Bitbucket option if your documentation source is stored in Bitbucket.
-
Enter the requested project information in the fields shown by the new-project workflow.
-
Review the project information before continuing.
-
Complete the new-project workflow using the confirmation control shown on screen.
-
Select Open Project Dashboard when it is available to open your new project’s focused workspace.
📷 Screenshot pending: A newly created project dashboard with project navigation and available documentation areas.
-
Select View Your Documentation → when it is available to open the documentation generated or collected for the project.
-
Select ← Back to Projects when you want to return to the full list of projects.
Tips and Best Practices
-
Create one project per documentation scope. Keep separate projects for distinct products, services, or codebases. This makes it easier to search, review changes, and compare versions without mixing unrelated material.
-
Use a recognizable project purpose. Before starting, decide whether the project represents a product, a service, a codebase, or a broader knowledge domain. This helps your team understand what belongs in the project.
-
Choose the correct repository provider. If you are using a connected source, select the provider that hosts it: GitHub, GitLab, or Bitbucket. Choosing the correct option at the start helps ensure the project is based on the intended source.
-
Use the Projects hub for navigation. The Projects screen is designed as the central place for managing project work. Use Search projects... when you need to locate a project quickly, especially as your workspace grows.
-
Use the focused project workspace after creation. A project can include areas for changes, analytics, versions, version comparisons, review, and screenshots. Start from the project dashboard so you remain in the context of the correct project.
-
Avoid deleting active work. The project interface includes Delete Project. Use this action carefully, particularly for projects that contain documentation history, version reviews, or screenshots.
Related Pages
- Manage Your Projects
- Open a Project Dashboard
- Search Across Projects
- Review Project Changes
- Work with Project Versions
- Compare Documentation Versions
- Review Project Screenshots
- View Project Analytics
Troubleshooting
You cannot find the New Project option
Return to the Projects hub and look for New Project. If it is not available, you may not have permission to create projects in the current workspace. Contact your Atloria workspace administrator to request access.
You are unsure whether to create a new project
Use Search projects... before creating a project. If a project already covers the same product, service, codebase, or knowledge domain, open that project instead of creating a duplicate.
You selected the wrong source provider
If the project workflow asks you to choose a source, select the provider that hosts your source material: GitHub, GitLab, or Bitbucket. If you cannot continue with the selected provider, verify that you have access to the repository and restart the new-project workflow with the correct option.
Was this page helpful?