What's Penify?

Penify is a Git App (GitHub/BitBucket) designed to automate the documentation for Git projects automatically.

It activates automatically after installation in your Git Repo. a. It tracks changes every time a pull request is merged. b. Penify recognizes new classes and functions in the code and updates documentation accordingly.

The core features of Penify are:

1. Full Repository Documentation
2. Automatic Documentation Update
3. Pull Request Analysis
4. AI Commits
5. Documentation Quality of your Repository.
6. API Documentation
7. Architecture Documentation
8. Git Commit Hooks

🛠️ How to Install Penify on GitHub?

Installing Penify on your GitHub repository or organization is a straightforward process. For Bitbucket, please check this document.

📋 Pre-requisites

• A GitHub account.
• If you face permissions issue, please connect with Penify Support team

🧭 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 Penify GitHub App Page

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

3. Initiate Installation

   

4. Select Installation Target 🏢

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

   

5. Configure Permissions

   • Review the permissions requested by Penify.
   • Grant the necessary permissions by clicking ‘Approve & install’ or a similar confirmation button.

6. Complete Installation

   • Once you approve the permissions, Penify will be installed on your selected repositories or organization. ✅
   • You will receive a confirmation message, and you may be redirected to Penify Dashboard.

7. Start Using Penify

   • Once installed, Penify will automatically start tracking pull requests and generate or update documentation accordingly. 📚

8. Troubleshooting Github App Installation

   • There could be multiple reason due to which the Github APP is not installed. Please go through this link if your Code Documentation is not getting generated.

🎥 Demo - Github