Code Insights page
  • 07 Nov 2024
  • 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 teams evaluate project dependencies and structure.

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. 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:

  • a timestamp showing when the analysis was last generated

  • Reanalyze Code to refresh the analysis data

  • Download JSON to use Code Insights artifacts with development tools

  • View PRD

Directory Descriptions tab

The Directory Descriptions tab provides a detailed view of each directory within the codebase. You can see directory paths along with descriptions for each section’s purpose and key components, including utility functions and modules. This view helps you understand the code structure, making it easier to 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.


Was this article helpful?

What's Next