Skip to content

Remade understanding-plugin.md #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Neootic3 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Remade understanding-plugin.md #52

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 27 additions & 8 deletions docs/getting-started/understanding-plugin.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,36 @@
# Understanding Plugins

:::warning
**Note:** Work is in progress 🚧
**Note:** Work in progress 🚧
:::

We are currently working on this section to provide you with detailed and comprehensive information about how Acode plugins work. Please check back soon for updates!
## What is a Plugin?

## Contribute to the Documentation
A Plugin is basically an **Add-on** you add them to the base of a platform to make it much more personalized and Fitted for specific cases.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The capitalization of "Plugin", "Add-on", and "Fitted" should be consistent with general noun usage in documentation. Also, the phrasing "you add them" could be improved for clarity.

Suggested change
A Plugin is basically an **Add-on** you add them to the base of a platform to make it much more personalized and Fitted for specific cases.
A plugin is basically an add-on that you add to the base of a platform to make it much more personalized and fitted for specific cases.

Copy link

@greptile-apps greptile-apps bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Grammar and capitalization issues: "you add them" should be "that you add", and "Fitted" should be lowercase

Suggested change
A Plugin is basically an **Add-on** you add them to the base of a platform to make it much more personalized and Fitted for specific cases.
A Plugin is basically an **Add-on** that you add to the base of a platform to make it much more personalized and fitted for specific cases.
Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/getting-started/understanding-plugin.md
Line: 9:9

Comment:
**style:** Grammar and capitalization issues: "you add them" should be "that you add", and "Fitted" should be lowercase

```suggestion
A Plugin is basically an **Add-on** that you add to the base of a platform to make it much more personalized and fitted for specific cases.
```

How can I resolve this? If you propose a fix, please make it concise.


We welcome contributions from the community! If you would like to help improve this documentation, please visit our [GitHub repository](https://github.com/bajrangCoder/acode-plugin-docs) and follow the contribution guidelines.
---

:::tip
You can suggest changes, add new content, or improve existing sections. Every bit of help is appreciated! 🤗
:::
## How Do Acode Plugins Work?

Acode Plugins put themselves on top of foundation by adding new features such as: **Ui Elements** , **functions**.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

Ensure consistent capitalization for "Plugins" and "UI Elements". The phrasing "put themselves on top of foundation" can be improved for clarity and grammar. Also, there's an extra space before the comma and a missing period at the end of the sentence.

Suggested change
Acode Plugins put themselves on top of foundation by adding new features such as: **Ui Elements** , **functions**.
Acode plugins build upon the foundation by adding new features such as: **UI elements**, **functions**.

Copy link

@greptile-apps greptile-apps bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Extra space before comma and "Ui Elements" should be "UI Elements"

Suggested change
Acode Plugins put themselves on top of foundation by adding new features such as: **Ui Elements** , **functions**.
Acode Plugins put themselves on top of foundation by adding new features such as: **UI Elements**, **functions**.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/getting-started/understanding-plugin.md
Line: 15:15

Comment:
**style:** Extra space before comma and "Ui Elements" should be "UI Elements"

```suggestion
Acode Plugins put themselves on top of foundation by adding new features such as: **UI Elements**, **functions**.
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.


think of Plugins as a supervisor that Make the default editor (worker) follow custom-made rules.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

The sentence should start with a capital letter, and "Make" should be lowercase. The phrasing could also be slightly more formal.

Suggested change
think of Plugins as a supervisor that Make the default editor (worker) follow custom-made rules.
Think of plugins as a supervisor that makes the default editor (the worker) follow custom-made rules.

Copy link

@greptile-apps greptile-apps bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Should start with capital letter and "Make" should be lowercase

Suggested change
think of Plugins as a supervisor that Make the default editor (worker) follow custom-made rules.
Think of Plugins as a supervisor that make the default editor (worker) follow custom-made rules.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/getting-started/understanding-plugin.md
Line: 17:17

Comment:
**style:** Should start with capital letter and "Make" should be lowercase

```suggestion
Think of Plugins as a supervisor that make the default editor (worker) follow custom-made rules.
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.



---

## Why do Plugins Exist?

Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

This sentence is a bit long and could be rephrased for better flow and readability.

Suggested change
Plugins exist as a way to personalize and customize the user experience, allowing users to create plugins that fit their workflow, making coding faster, easier, and more accessible.

Plugins exist as a way to personalize and customize the user experience, a user can make a plugin that fits their workflow and make coding faster, easier and more accessible.

---

## What are the types of Plugins?

There are many types of plugins like:

• **Productivity based:** Plugins that help you do a specific task quicker.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

"quicker" should be "more quickly" as it modifies the verb "do".

Suggested change
• **Productivity based:** Plugins that help you do a specific task quicker.
• **Productivity-based:** Plugins that help you do a specific task more quickly.


• **Feature based:** Plugins that add niche features to a specific type of development.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

"Feature based" should be hyphenated as it acts as a compound adjective.

Suggested change
• **Feature based:** Plugins that add niche features to a specific type of development.
• **Feature-based:** Plugins that add niche features to a specific type of development.


For more information, see official [Guide](https://acode.app/plugin-docs).
• **Malicious Plugins:** that are intended to make your experience awful.
Copy link

@gemini-code-assist gemini-code-assist bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

medium

"Malicious Plugins" should be "Malicious plugins" for consistency. Also, the description could be slightly more formal for documentation.

Suggested change
• **Malicious Plugins:** that are intended to make your experience awful.
• **Malicious plugins:** that are intended to negatively impact your experience.

Comment on lines +32 to +36
Copy link

@greptile-apps greptile-apps bot Jan 21, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

style: Use markdown list formatting (-) instead of bullet characters (•)

Suggested change
• **Productivity based:** Plugins that help you do a specific task quicker.
• **Feature based:** Plugins that add niche features to a specific type of development.
For more information, see official [Guide](https://acode.app/plugin-docs).
• **Malicious Plugins:** that are intended to make your experience awful.
- **Productivity based:** Plugins that help you do a specific task quicker.
- **Feature based:** Plugins that add niche features to a specific type of development.
- **Malicious Plugins:** that are intended to make your experience awful.

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Prompt To Fix With AI 
This is a comment left during a code review.
Path: docs/getting-started/understanding-plugin.md
Line: 32:36

Comment:
**style:** Use markdown list formatting (`-`) instead of bullet characters (`•`)

```suggestion
- **Productivity based:** Plugins that help you do a specific task quicker.

- **Feature based:** Plugins that add niche features to a specific type of development.

- **Malicious Plugins:** that are intended to make your experience awful.
```

<sub>Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!</sub>

How can I resolve this? If you propose a fix, please make it concise.