Atloria brings your projects, generated documentation, source intelligence, and public documentation experiences together in one workspace. This page helps you understand where to look for each type of information so you can find the right documentation quickly.
Overview
An Atloria workspace is the place where you organize and explore documentation for your organization’s projects. Start from the projects hub to see the projects available to you, then open a project to review its documentation, source-derived insights, and available exploration tools.
Projects are the central organizing unit in the workspace. They let you separate documentation for different products, services, or applications while keeping them accessible from a shared project list. Use the dashboard and project search when your organization has many projects or when you need to move quickly between work areas.
Within a project, Atloria can present documentation alongside source intelligence. Source intelligence helps you understand how parts of a product relate to one another, such as frontend, backend, database, API schema, configuration, documentation, and infrastructure areas. Depending on the project, you may also see options such as Overview, Source, View Source, ⚡ API Explorer, and Atloria Stack.
📷 Screenshot pending: The projects hub showing the project list, project search, and cross-project search options.
Prerequisites
Before you begin, make sure that:
- You can sign in to Atloria and have access to your organization’s workspace.
- You have been given access to at least one project, if your organization restricts project visibility.
- You know the name of the project, document, or category you want to explore when using search.
- Your project has documentation available, either generated through Atloria or added through Or import existing documentation.
- You have the appropriate access level if you need to view source-related information or share public documentation.
Step-by-Step Instructions
-
Open the projects hub.
Begin from the area labeled Projects. This is your starting point for finding the projects available in your workspace. The hub is designed to give you a single place to move between projects rather than requiring you to search through individual documentation pages. -
Find the project you want to explore.
Use Search projects... to narrow the visible project list by project name. If you are not sure which project contains the information you need, use Search across all projects... instead. This broader search is useful when you know a document title, category, or topic but do not know where it belongs. -
Open the project dashboard.
Select a project from the list. The project’s main area may include an entry such as 1. Dashboard Overview or an Overview action. The dashboard gives you an at-a-glance starting point before you open a specific document or source view. -
Explore the project documentation.
Look for documentation categories and documents within the project. You can use Search documents, categories, projects... to find content by its title or category. When documentation is not yet available, you may see Generate Documentation → to create documentation from the project, or Or import existing documentation to bring in documentation your team already maintains. -
Review source intelligence when you need implementation context.
Select Source or View Source when you need to understand the material behind a documentation topic. These views help connect documentation to the project’s analyzed areas. For example, a project may organize information across frontend, backend, database, API schema, configuration, documentation, and infrastructure topics. -
Use specialized exploration views where available.
Choose ⚡ API Explorer to focus on API-related information. Select Atloria Stack when you want a broader view of the technologies and areas identified in the project. These options may not appear for every project, because the available views depend on the project’s content and analysis. -
Return to the project list when you are finished.
Use ← Back to Projects or ← Back to Projects to return to the projects hub. This keeps navigation simple when you need to compare documentation across multiple projects. -
Open a public portal when documentation is shared externally.
Documentation marked Public can be made available through a public documentation portal. A public portal is intended for readers who need documentation without working inside the full organization workspace. Public readers can navigate available documentation and, where enabled, search for information.
📷 Screenshot pending: A project documentation view showing Overview, Source, View Source, API Explorer, Atloria Stack, and document search.
Tips and Best Practices
Use the narrowest search first. If you know the project name, start with Search projects.... If you only know a feature name, document title, or category, use Search across all projects... or Search documents, categories, projects.... This reduces the amount of irrelevant information in your results.
Start with Overview before opening Source. The overview is usually the best place to understand the purpose and scope of a project or documentation area. Move to Source or View Source when you need more context about how the documented areas connect.
Use the project’s categorized information to understand scope. Atloria can distinguish areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. Reviewing these areas helps you identify whether you are looking at user-facing behavior, service behavior, data-related information, or deployment and configuration information.
Generate or import documentation intentionally. Choose Generate Documentation → when you want Atloria to create documentation from the project’s available intelligence. Choose Or import existing documentation when your organization already has approved material that should be included in the workspace.
Before sharing content publicly, confirm that it is intended for external readers. The Public designation is useful for customer, partner, or developer-facing documentation, but internal operational details should remain in the appropriate private project workspace.
Related Pages
- Find Projects and Documentation
- Generate Documentation
- Import Existing Documentation
- Use Source Intelligence
- Explore APIs with API Explorer
- Manage Public Documentation Portals
Troubleshooting
I cannot find a project
First, use Search projects... and enter part of the project name. If the project still does not appear, try Search across all projects... in case the content is indexed under a different project name. If no results are available, you may not have access to that project; contact your organization’s Atloria administrator.
I can see a project but cannot find its documentation
Open the project and use Search documents, categories, projects.... If the project has no documentation results, it may not have been generated or imported yet. Look for Generate Documentation → or Or import existing documentation, or ask the project owner whether documentation is available.
I do not see Source, API Explorer, or Atloria Stack
These options are available only when the project contains the relevant analyzed information. Start with Overview to confirm that you are in the correct project. If the expected view is still unavailable, the project may need additional source analysis or your access level may limit what you can view.
Was this page helpful?