Entelligence AI Code Documentation

Entelligence supports generating automated codebase documentation complete with implementation details, code references, and automated diagrams.

The Entelligence codebase documentation agents automatically synthesize the codebase and generate a list of high level sections that break down the codebase into its key sections and then provide an architecture diagram, walkthrough and list of references for each section. Engineers in the team are then able to live edit and collaborate on the documentation to add or edit any extra details. Let's dive in and see how it works.

Step 1: Generate the Documentation

The documentation tab lists out all of the codebases for which your organization has generated documentation and time of last update. Anyone in the organization can generate a documentation for any of the codebases available for the organization.

Step 2: Understand the Architecture diagram

Each key section in the codebase documentation includes an architecture diagram that explains the flow of the code. It's followed by a break down of the key components of this section with dynamic in line links. Each of these sections generate a live explanation of the section for a more thorough description of that section.

The documentation is always up-to-date with the latest commits. The AI agent deconstructs the large code base into key conceptual areas, providing a clear understanding of the code base.

Step 3: Explore the Breakdown

Each section is broken up into the key components. These are auto analyzed from the code hierarchy to combine all the important functions and functionality corresponding to each of the subsections. You can add a new subsection by hitting / and triggering a generation of a new section in the documentation.

Step 4: Edit the Documentation

You're free to edit the documentation. For instance, if you want to add more explanation about how cycles work, go ahead and update it. The changes are saved live in our system. This allows for real time team collaboration and edits as well as enabling engineers to fill in any additional details or sections that might be missing in the original documentation.

Step 5: Understand Specific Sections

To understand a particular section, click on it. The system will walk you through real-time updates of how cycles and lang graph are updated, including nodes, examples of a cycle, branching, different types of branching, and more.

Step 6: Create Custom Sections

The document isn't static. You can create new custom sections and have the system walk through parts that it might not have captured on its own.

Step 7: Refer to the Documentation

At the end of the process, you'll find the reference docs.

You can proceed to the next section by clicking on it.

Each section follows this format of document, explanation, and interactive elements. You'll also find references that pull up the actual code snippets and files for better understanding of the section.

Step 8: Try it Out

We're thrilled for you to try this out.

Enjoy exploring this new feature!