Sample projects let you see how Atloria turns an application’s source into navigable analysis and AI-generated documentation. Use them to become familiar with the project workspace before working with your own projects.
Overview
Sample projects provide a safe way to explore Atloria’s project-level views without changing your own source or documentation. From the Projects hub, you can search for a project, open it, and review the available actions for examining source, exploring APIs, and generating documentation.
When you open a sample project, Atloria can organize what it finds across areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure. This helps you understand how different parts of an application are represented in Atloria and how they contribute to generated documentation.
Sample projects are also useful when you want to compare source analysis with the resulting documentation. You can inspect source information through View Source, explore available API information through ⚡ API Explorer, and use Generate Documentation → when you are ready to create documentation from the project.
📷 Screenshot pending: The Projects hub showing project search and available sample projects.
Prerequisites
Before you begin, make sure that you have:
- Access to Atloria and the Projects area.
- A sample project available in your organization’s project list.
- Permission to view project source information if you plan to use View Source.
- A clear exploration goal, such as reviewing source analysis, checking API information, or generating documentation.
Step-by-Step Instructions
-
Select Projects to open the project hub.
-
Enter a project name or keyword in the Search projects... field to narrow the project list.
-
Select the sample project that you want to explore.
-
Select View Source to review the source information available for the sample project.
-
Select ⚡ API Explorer to examine the project’s available API-related information.
-
Select Atloria Stack to view the project through Atloria’s stack-oriented perspective.
-
Select Generate Documentation → when you want Atloria to create documentation based on the sample project.
-
Select View Your Documentation → after generation to open the resulting documentation.
-
Enter a keyword in Search documents, categories, projects... to locate a generated document, category, or project-related result.
-
Select Export Documentation if you need to take the generated documentation outside Atloria.
📷 Screenshot pending: A sample project open in Atloria with the View Source, API Explorer, Atloria Stack, and Generate Documentation actions visible.
Tips and Best Practices
-
Start with a small, focused question. For example, use a sample project to understand how a frontend component relates to a backend service, rather than trying to review the entire project at once.
-
Use View Source before generating documentation when you want to compare the underlying project information with the generated result. This makes it easier to understand what Atloria is documenting.
-
Check ⚡ API Explorer when the sample project includes APIs. API information may be useful for understanding how application areas connect and for validating generated API-focused documentation.
-
Use Atloria Stack to explore the project by technical area. Atloria can identify areas such as frontend, backend, database, API schema, configuration, documentation, and infrastructure, which can help you focus your review.
-
Use the search fields for their intended scope. Search projects... helps you find a project from the project hub, while Search across all projects... is useful when you need broader project-level searching. Use Search documents, categories, projects... when you are looking for documentation content or categories.
-
Treat sample-project documentation as an example of the generation workflow. After reviewing it, you can apply the same process to your own project and compare the results with existing materials imported through Or import existing documentation.
Related Pages
- Getting Started
- Generate Documentation
- Explore Source Analysis
- Use API Explorer
- Search Projects and Documentation
- Export Documentation
Troubleshooting
You cannot find a sample project
Select Projects, then use Search projects... with a broader keyword. If the sample project still does not appear, ask your Atloria administrator whether sample projects are available in your organization.
The source or API views do not show the information you expected
Select View Source or ⚡ API Explorer again after confirming that you opened the intended sample project. Some projects may emphasize different areas, such as frontend components, backend services, database structures, or API schemas.
You generated documentation but cannot locate it
Select View Your Documentation →, then use Search documents, categories, projects... to search by a document title, category, or project keyword.
Was this page helpful?