Add plugins faq #184
Add plugins faq #184
Conversation
✅ Deploy Preview for pelica ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughAdds a new "Plugins" tab to the FAQ page ( Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/faq.mdx
🔇 Additional comments (1)
src/pages/faq.mdx (1)
150-151: Provide source documentation for the blueprint creator quote or clarify its origin.The exact quote on lines 150–151 could not be verified in any public sources (GitHub issues, official documentation, or statements). Since this is presented as a direct quotation attributed to the blueprint creator, either link to the original source (Discord, GitHub discussion, etc.) or rephrase it as a paraphrased statement with a source reference to ensure accuracy and credibility for users.
There was a problem hiding this comment.
Actionable comments posted: 2
♻️ Duplicate comments (2)
src/pages/faq.mdx (2)
170-174: Fix relative path to internal documentation link.The link uses an incorrect relative path that was previously flagged. From
src/pages/faq.mdx, the path./docs/panel/advanced/pluginsresolves to a non-existent location. Use../../docs/panel/advanced/plugins#install-a-pluginor/docs/panel/advanced/plugins#install-a-plugininstead.🔎 Proposed fix
- You can find information on that [here](./docs/panel/advanced/plugins#install-a-plugin). + You can find information on that [here](/docs/panel/advanced/plugins#install-a-plugin).
175-179: Fix relative path to internal documentation link.The link uses an incorrect relative path that was previously flagged. Use
../../docs/panel/advanced/plugins#create-a-pluginor/docs/panel/advanced/plugins#create-a-plugininstead of./docs/panel/advanced/plugins#create-a-plugin.🔎 Proposed fix
- You can find detailed information on that [here](./docs/panel/advanced/plugins#create-a-plugin). + You can find detailed information on that [here](/docs/panel/advanced/plugins#create-a-plugin).
📜 Review details
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/pages/faq.mdx
🔇 Additional comments (1)
src/pages/faq.mdx (1)
180-187: LGTM!The sneak peek plugins FAQ entry provides clear information with a properly formatted external link. Overall, the new Plugins tab is a valuable addition to the FAQ that follows the established pattern and provides comprehensive information about the plugin system.
| <TabItem label="Plugins" value="plugins"> | ||
| <details> | ||
| <summary>When will the plugin system be available?</summary> | ||
|
|
||
| The plugin system was released with beta30! | ||
| </details> | ||
| <details> | ||
| <summary>Will pterodactyl addons work with the new system?</summary> | ||
|
|
||
| No. Pterodactyl "addons" are just code modifications. Our codebase now greatly differs from pterodactyls. | ||
| Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files. | ||
| </details> |
There was a problem hiding this comment.
Good structure, but fix possessive form.
The new Plugins tab integrates well with the existing FAQ structure. However, line 144 has a grammar issue.
🔎 Proposed fix for possessive form
- No. Pterodactyl "addons" are just code modifications. Our codebase now greatly differs from pterodactyls.
+ No. Pterodactyl "addons" are just code modifications. Our codebase now greatly differs from Pterodactyl's.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <TabItem label="Plugins" value="plugins"> | |
| <details> | |
| <summary>When will the plugin system be available?</summary> | |
| The plugin system was released with beta30! | |
| </details> | |
| <details> | |
| <summary>Will pterodactyl addons work with the new system?</summary> | |
| No. Pterodactyl "addons" are just code modifications. Our codebase now greatly differs from pterodactyls. | |
| Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files. | |
| </details> | |
| <TabItem label="Plugins" value="plugins"> | |
| <details> | |
| <summary>When will the plugin system be available?</summary> | |
| The plugin system was released with beta30! | |
| </details> | |
| <details> | |
| <summary>Will pterodactyl addons work with the new system?</summary> | |
| No. Pterodactyl "addons" are just code modifications. Our codebase now greatly differs from Pterodactyl's. | |
| Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files. | |
| </details> |
🤖 Prompt for AI Agents
In src/pages/faq.mdx around lines 135 to 146, fix the possessive/capitalization
issues: change "pterodactyls" to the possessive and proper-cased "Pterodactyl's"
on the line about addons, and likewise change "Pelicans plugin system" to
"Pelican's plugin system" so both project names are capitalized and use the
correct apostrophe for possession.
| <details> | ||
| <summary>Do I need the commercial license to use or develop plugins?</summary> | ||
|
|
||
| No. Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files. | ||
| </details> |
There was a problem hiding this comment.
Fix possessive form: "Pelicans" → "Pelican's".
Line 156 is missing the possessive apostrophe.
🔎 Proposed fix
- No. Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files.
+ No. Pelican's plugin system will be a "real" plugin system where plugins don't touch any core files.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| <details> | |
| <summary>Do I need the commercial license to use or develop plugins?</summary> | |
| No. Pelicans plugin system will be a "real" plugin system where plugins don't touch any core files. | |
| </details> | |
| <details> | |
| <summary>Do I need the commercial license to use or develop plugins?</summary> | |
| No. Pelican's plugin system will be a "real" plugin system where plugins don't touch any core files. | |
| </details> |
🤖 Prompt for AI Agents
In src/pages/faq.mdx around lines 153 to 157, the phrase "Pelicans plugin
system" uses the incorrect non‑possessive form; change it to the possessive
"Pelican's plugin system" (add the apostrophe) so the sentence reads that
Pelican owns the plugin system; update that single line and scan nearby
occurrences for the same possessive mistake to keep wording consistent.
Taken from discord: https://discord.com/channels/1218730176297439332/1404762445490421821/1404767200828723302
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.