Code Insights page
  • 07 Jan 2025
  • 1 Minute to read
  • Dark
    Light
  • PDF

Code Insights page

  • Dark
    Light
  • PDF

Article summary

The Code Insights page provides a structured analysis of the connected codebase, helping your teams evaluate project dependencies and structure. You can navigate directory structures and assess dependencies with enhanced tools, improving your ability to manage and maintain the codebase. You can also download insights as a JSON file for integration with other tools or view the PRD for the codebase.

Prerequisites

To access the Code Insights page, you must first connect your codebase to a GitHub repository. This connection enables Crowdbotics to analyze the repository’s content and generate insights on dependencies and directory structure. If you created your PRD using the Code-to-Spec workflow, your repository is already connected. Otherwise, for instructions on connecting to a GitHub repository outside of the Code-to-Spec workflow, refer to GitHub Integration.

Using Code Insights

The page includes the following:

  • Timestamp: Displays the date and time when the analysis was last generated, helping you track the freshness of the insights.

  • JSON: Use this feature to export Code Insights artifacts as a JSON file. This structured format facilitates integration with tools like Jira, enables archiving, and supports custom workflows.

  • Reanalyze Code: Click this button to refresh the analysis data and generate the latest insights based on the current state of your codebase.

  • View PRD: Navigate directly to the generated PRD for the project, which provides detailed documentation for the connected codebase.

Directory Descriptions tab

The Directory Descriptions tab provides a detailed view of each directory within the codebase, now with an enhanced file tree component for improved navigation. You can explore directory paths and quickly locate files or folders, with descriptions clarifying their purpose and key components, such as utility functions and modules. This streamlined view helps you understand the code structure, making it easier to explore, plan, and maintain the codebase.

Dependencies tab

The Dependencies tab lists third-party libraries detected in the connected repository. With this feature, you can assess external libraries and tools required by the project, which helps in planning migrations and enables downstream teams to estimate project scope more accurately. By understanding dependencies, your teams can coordinate development efforts more effectively and minimize risks associated with third-party updates.


Was this article helpful?

What's Next