Skip to content

What's Snorkell.ai? โ€‹

Snorkell.ai is an intelligent GitHub App designed to automate the process of generating and updating documentation for GitHub projects.

It activates automatically after installation, tracking changes every time a pull request is merged. Snorkell.ai recognizes new classes and functions in the code and crafts or updates documentation accordingly, creating a PR for review before merging.

This tool saves time, ensures documentation consistency, and simplifies onboarding for new team members by keeping documentation in sync with code changes. It's ideal for startups, large teams, and open source projects.

๐Ÿ› ๏ธ How to Install Snorkell.ai on GitHub? โ€‹

Installing Snorkell.ai on your GitHub repository or organization is a straightforward process. This guide will walk you through the steps to integrate Snorkell.ai, ensuring your project's documentation is automatically generated and updated.

๐Ÿ“‹ Pre-requisites โ€‹

  • A GitHub account.
  • Administrative access to the repository or organization where Snorkell.ai will be installed.
  • If you don't have admin privilege, you can choose another path by clicking on this link.

๐Ÿงญ Step-by-Step Installation Guide โ€‹

  1. Log In to GitHub

    • Open your web browser and navigate to GitHub.
    • Sign in to your GitHub account. ๐Ÿ”‘
  2. Access the Snorkell.ai GitHub App Page

    • Go to the Snorkell.ai app page Github App.
    • It can also be found through the GitHub Marketplace or by visiting the Snorkell.ai website and selecting the option to install.
  3. Initiate Installation

    • Click on the green โ€˜Installโ€™ ๐ŸŸข. This will redirect you to a page where you can choose where to install Snorkell.ai.

    Snorkel AI Installation

  4. Select Installation Target ๐Ÿข

    • Choose whether to install Snorkell.ai for your personal account or for an organization.
    • If you manage multiple organizations or repositories, select the ones where you wish to install Snorkell.ai.

    Snorkel AI Installation

  5. Configure Permissions

    • Review the permissions requested by Snorkell.ai. These permissions are necessary for the app to access your code and generate documentation. ๐Ÿ”’
    • Grant the necessary permissions by clicking โ€˜Approve & installโ€™ or a similar confirmation button.
  6. Complete Installation

    • Once you approve the permissions, Snorkell.ai will be installed on your selected repositories or organization. โœ…
    • You will receive a confirmation message, and you may be redirected to Snorkell.ai Dashboard.
  7. Verify Installation

    • Go to the โ€˜Settingsโ€™ of your repository or organization.
    • Navigate to the โ€˜Installed GitHub Appsโ€™ section to confirm that Snorkell.ai is listed there.
  8. Start Using Snorkell.ai

    • Once installed, Snorkell.ai will automatically start tracking pull requests and generate or update documentation accordingly. ๐Ÿ“š

๐ŸŽฅ Demo - Github โ€‹

Video Name