Explore Product Flow Entities

Use the EntityTree to explore the product entities identified in your project and understand how they relate to one another. This view helps you review product flow documentation by moving from individual entities to the relationships that connect the product experience.

Overview

Product flow entities represent the parts of your application that contribute to how the product works. Depending on the project content, these can include frontend entities such as components, hooks, pages, layouts, contexts, providers, and stores, as well as backend entities such as controllers, services, repositories, middleware, routes, and database-related items.

The EntityTree organizes these entities so you can browse them in a structured view rather than searching through source material manually. Use it when you need to understand where a product capability is represented, identify related parts of the application, or prepare to review the product flow documentation.

Relationships provide the context behind the tree. For example, one component may render another component, or a component may use a hook. Reviewing these connections helps you follow the path of a product interaction across the entities involved, instead of treating each item as an isolated technical artifact.

📷 Screenshot pending: The EntityTree showing product entities and their relationship hierarchy.

Prerequisites

Before you begin, make sure that:

• You have access to the relevant project in Atloria.
• The project version you want to review is available.
• Product or source intelligence has been generated or imported for the project.
• You know the product area, screen, feature, or entity name you want to investigate.
• You can access the project’s review area when you need to return to the documentation review workflow.

Step-by-Step Instructions

1. Open the project and choose the version you want to investigate.

   Start from the project that contains the product flow documentation you need to review. Select the appropriate version so that the EntityTree reflects the correct snapshot of the product and its source intelligence.

2. Navigate to the product flow entity view.

   Open the EntityTree from the project’s product documentation and review area. The tree presents entities in an organized structure, helping you move from broad product areas into the individual items that support them.

   If you are working from the review workflow, use Back to Review when you need to return to the review summary after exploring entities.

3. Browse the entity hierarchy.

   Expand the available branches to inspect the entities identified for the product. The tree may include entities such as:

   • Components
   • Hooks
   • Pages
   • Layouts
   • Routes
   • Contexts and providers
   • Stores
   • Controllers
   • Services
   • Repositories
   • Middleware

   Use the hierarchy to understand which entities belong together. For example, a page may contain or render components, while those components may use hooks or shared context.

4. Search for a specific entity.

   Use the Search entities… field to find an entity by name. Enter a meaningful term, such as a page name, a component name, or a feature keyword.

   Search is especially useful in larger projects where the tree contains many frontend, backend, database, API schema, configuration, documentation, or infrastructure entities. If your search does not immediately show the expected item, try a shorter or more distinctive part of the entity name.

📷 Screenshot pending: The “Search entities…” field filtering the EntityTree to matching product entities.

5. Select an entity to examine its connections.

   Choose an entity in the tree to focus your review on that item and its relationships. Look for relationship descriptions that explain how entities interact. Common relationship language can include renders and uses.

   For example, if a component renders another component, the relationship helps you understand the visible composition of a product screen. If a component uses a hook, the relationship can indicate where that component receives shared behavior or data.

6. Use source information when you need additional context.

   When source context is available, select View Source to inspect the supporting source material associated with the entity. Use this only when you need to confirm what an entity represents or validate a relationship shown in the EntityTree.

   The EntityTree is intended to support product understanding first. Source information is useful for resolving uncertainty, but you can often understand the overall product flow by following the entity hierarchy and relationship labels.

7. Return to documentation review.

   After identifying the entities relevant to the product flow, use Back to Review to continue reviewing the generated documentation. You can use what you learned from the EntityTree to assess whether the documentation accurately describes the product experience and its supporting relationships.

Tips and Best Practices

• Start with the product-facing entity. Begin with a page, layout, or visible component when you are investigating a user journey. Then follow relationships such as renders to understand what appears within that experience.

• Use relationships to follow behavior. A relationship such as uses can help you trace shared behavior from a component to a hook, context, provider, store, or service. This is useful when a feature’s behavior is not fully represented by a single screen-level entity.

• Search before manually expanding a large tree. The Search entities… field is the fastest way to locate a known entity. Once you find it, use its surrounding hierarchy and relationships to identify related entities.

• Review across product layers when necessary. A user-facing feature can involve more than frontend entities. Follow the flow into controllers, services, repositories, routes, database items, or API schema entities when you need a fuller understanding of how the product capability is supported.

• Use the EntityTree as a review aid. During documentation review, compare the entities and relationships you find with the written product flow. If an important page, component, or connection appears absent from the documentation, flag it for follow-up before publishing.

Related Pages

• Review Product Flow Documentation
• Use the Review Summary
• View Source for Documentation Review
• Generate Documentation
• Export Documentation

Troubleshooting

I cannot find the entity I am looking for

Use Search entities… and try a shorter search term. Entity names may be based on the product’s underlying structure, so search for a distinctive word from the page, component, feature, or service name. If the entity still does not appear, verify that you opened the correct project version.

The relationships do not explain the full product flow

Start with the visible product entity and inspect related entities step by step. A complete flow may span multiple layers, such as a page, component, hook, controller, service, and repository. Use View Source when you need supporting context for an unclear relationship.

I need to return to the documentation review workflow

Select Back to Review. This returns you to the review area, where you can continue reviewing the documentation after investigating the relevant entities and relationships.