You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Penify is an intelligent GitHub App designed to automate the process of generating and updating documentation for GitHub projects.
13
+
Penify is a Git App (GitHub/BitBucket) designed to automate the documentation for Git projects automatically.
14
+
15
+
It activates automatically after installation in your Git Repo.
16
+
a. It tracks changes every time a pull request is merged.
17
+
b. Penify recognizes new classes and functions in the code and updates documentation accordingly.
14
18
15
-
It activates automatically after installation, tracking changes every time a pull request is merged. Penify recognizes new classes and functions in the code and crafts or updates documentation accordingly, creating a PR for review before merging.
Installing Penify on your GitHub repository or organization is a straightforward process. This guide will walk you through the steps to integrate Penify, ensuring your project's documentation is automatically generated and updated.
34
+
Installing Penify on your GitHub repository or organization is a straightforward process. For Bitbucket, please check this [document](./install_penify_on_bitbucket.md).
31
35
32
36
### 📋 Pre-requisites
33
37
34
38
- A GitHub account.
35
-
- Administrative access to the repository or organization where Penify will be installed.
36
-
- If you don't have admin privilege, you can choose another path by clicking on this link.
39
+
- If you face permissions issue, please connect with [Penify Support team](https://calendly.com/sumansaurabh-snorkell/intro-snorkell-i)
37
40
38
41
### 🧭 Step-by-Step Installation Guide
39
42
@@ -56,21 +59,17 @@ Installing Penify on your GitHub repository or organization is a straightforward
- Review the permissions requested by Penify. These permissions are necessary for the app to access your code and generate documentation. 🔒
62
+
- Review the permissions requested by Penify.
60
63
- Grant the necessary permissions by clicking ‘Approve & install’ or a similar confirmation button.
61
64
62
65
6.**Complete Installation**
63
66
- Once you approve the permissions, Penify will be installed on your selected repositories or organization. ✅
64
-
- You will receive a confirmation message, and you may be redirected to [Penify Dashboard](https://dashboard.penify.ai/).
65
-
66
-
7.**Verify Installation**
67
-
- Go to the ‘Settings’ of your repository or organization.
68
-
- Navigate to the ‘Installed GitHub Apps’ section to confirm that Penify is listed there.
67
+
- You will receive a confirmation message, and you may be redirected to [Penify Dashboard](https://dashboard.penify.dev/).
69
68
70
-
8.**Start Using Penify**
69
+
7.**Start Using Penify**
71
70
- Once installed, Penify will automatically start tracking pull requests and generate or update documentation accordingly. 📚
72
71
73
-
9.**Troubleshooting Github App Installation**
72
+
8.**Troubleshooting Github App Installation**
74
73
- 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.
0 commit comments