Skip to content

Commit daafa01

Browse files
committed
feat: Add installation instructions for BitBucket and enhance documentation clarity
1 parent a8c4347 commit daafa01

2 files changed

Lines changed: 23 additions & 20 deletions

File tree

.vitepress/config.mts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,10 @@ export default defineConfig({
115115
text: "🔧 Install on AzureDevops",
116116
link: "/docs/install-penify-on-AzureDevops",
117117
},
118+
{
119+
text: "🔧 Install on BitBucket",
120+
link: "/docs/install_penify_on_bitbucket",
121+
},
118122
{
119123
text: "🔑 Setup penify.config.json",
120124
link: "/docs/penify-config-json.md",

docs/what-is-penify.md

Lines changed: 19 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,30 +10,33 @@ image: https://www.penify.dev/_next/static/media/suman.1cf25c09.webp
1010

1111
# What's Penify?
1212

13-
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.
1418

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

1720
**The core features of Penify are:**
1821

19-
1. Code Documentation
20-
2. Pull Request Documentation
21-
3. API Documentation
22-
4. Architecture Documentation
23-
5. Git Commit Hooks
24-
6. [Commit Documentation](./ci-commit-documentation.md.md)
25-
7. [Repo Documentation](./repo-documentation.md)
22+
1. [Full Repository Documentation](./repo-documentation.md)
23+
2. [Automatic Documentation Update](./ci-commit-documentation.md)
24+
3. [Pull Request Analysis](./instant-pull-request-insight.md)
25+
4. [AI Commits](./commit-documentation-cli.md)
26+
5. Documentation Quality of your Repository.
27+
6. API Documentation
28+
7. Architecture Documentation
29+
8. Git Commit Hooks
2630

2731

2832
## 🛠️ How to Install Penify on GitHub?
2933

30-
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).
3135

3236
### 📋 Pre-requisites
3337

3438
- 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)
3740

3841
### 🧭 Step-by-Step Installation Guide
3942

@@ -56,21 +59,17 @@ Installing Penify on your GitHub repository or organization is a straightforward
5659
![Penify Installation](../public/images/install-authorize.png)
5760

5861
5. **Configure Permissions**
59-
- 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.
6063
- Grant the necessary permissions by clicking ‘Approve & install’ or a similar confirmation button.
6164

6265
6. **Complete Installation**
6366
- 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/).
6968

70-
8. **Start Using Penify**
69+
7. **Start Using Penify**
7170
- Once installed, Penify will automatically start tracking pull requests and generate or update documentation accordingly. 📚
7271

73-
9. **Troubleshooting Github App Installation**
72+
8. **Troubleshooting Github App Installation**
7473
- 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.
7574

7675
### 🎥 Demo - Github

0 commit comments

Comments
 (0)