Using Code-to-Spec
  • 24 Oct 2024
  • 1 Minute to read
  • Dark
    Light
  • PDF

Using Code-to-Spec

  • Dark
    Light
  • PDF

Article summary

For general information on the Code-to-Spec refer to Code-to-Spec. Use the following steps to create a PRD from your GitHub repository.

Begin by creating an app.

  1. Log in to your account and go to your dashboard:
    https://app.crowdbotics.com/dashboard/create-app  
  2. On your dashboard, click + Create App.
  3. Give your app a name (maximum 25 characters).
  4. (Optional) Upload an app icon.

Import from GitHub

  1. Choose the Advanced Settings option to access additional configuration options.

  2. Select the Import from GitHub option. (Note: Deployment options are not available in this process.)

  3. (Optional) If the GitHub connection has not been configured, follow the steps through the Connect to GitHub flow.

  4. From the drop-down list, select the GitHub repository you want to import.

  5. Click Next to create the project.
    The platform begins importing the repository.

  6. On the Create a PRD page, click Turn your GitHub into a PRD. On the resulting screen, set the following:

    • GitHub Branch: Choose the branch that contains the main version of your project (e.g., "main" or "production").

    • Directory Paths: Select the file paths or directories that are relevant to your project. This ensures a comprehensive analysis and accurate report generation.
      (Note: Selecting the "/" option includes only the root directory).

  7. Click Next.
    This process can take up to an hour, depending on the size of the files you've selected. You can leave the page and return later to continue.

Once the process is complete, the platform uses the final summary to:

  • Generate Code Insights that analyze the codebase.

  • Create an app description in the App Info tab.

  • Populate the PRD with phases, features, and settings based on the GitHub codebase, rather than based on the default app description.

The PRD is now ready, and you can proceed with fine-tuning your PRD as well as the usual planning, development, and maintenance activities using the PRD.


Was this article helpful?