starred/plugins
1
0
Fork 0
mirror of https://github.com/pelican-dev/plugins.git synced 2026-05-09 08:26:01 +02:00
Code Issues 13 Projects Packages Wiki Activity

[PR #35] [MERGED] Split READMEs to the plugins #78

New issue
Closed
opened 2026-05-07 00:17:57 +02:00 by BreizhHardware · 0 comments
BreizhHardware commented 2026-05-07 00:17:57 +02:00
Owner
Copy link

📋 Pull Request Information

Original PR: https://github.com/pelican-dev/plugins/pull/35
Author: @PalmarHealer
Created: 12/21/2025
Status: ✅ Merged
Merged: 12/23/2025
Merged by: @Boy132

Base: main ← Head: palmarhealer/add-readmes

📝 Commits (4)

  • 8c7b4f8 Add READMEs for various plugins/themes, documenting features and technical details
  • 5bcd52b Add additional notes and warnings to plugin READMEs
  • a3dbf9b Remove technical details sections from plugin and theme READMEs.
  • c3fff9b cleanup

📊 Changes

20 files changed (+234 additions, -135 deletions)

View changed files

📝 README.md (+28 -135)
➕ announcements/README.md (+14 -0)
➕ billing/README.md (+17 -0)
➕ fluffy-theme/README.md (+8 -0)
➕ generic-oidc-providers/README.md (+9 -0)
➕ legal-pages/README.md (+10 -0)
➕ mclogs-uploader/README.md (+9 -0)
➕ minecraft-modrinth/README.md (+13 -0)
➕ pirate-language/README.md (+13 -0)
➕ player-counter/README.md (+19 -0)
➕ pterodactyl-theme/README.md (+8 -0)
➕ register/README.md (+8 -0)
➕ robo-avatars/README.md (+9 -0)
➕ rust-umod/README.md (+9 -0)
➕ snowflakes/README.md (+9 -0)
➕ subdomains/README.md (+10 -0)
➕ tawkto-widget/README.md (+8 -0)
➕ theme-customizer/README.md (+9 -0)
➕ tickets/README.md (+10 -0)
➕ user-creatable-servers/README.md (+14 -0)

📄 Description

I thought this would be nicer since the main README stays very simple and the READMEs inside the plugins can be more comprehensive.

and this system is very similar to https://github.com/pelican-eggs

Summary by CodeRabbit

  • Documentation
    • Reorganized main README into a concise, categorized bullet list (Plugins, Themes, Language Packs) and adjusted intro wording for consistency.
    • Added or updated documentation for 19 extensions and themes (e.g., Announcements, Billing, Player Counter, Tickets, Theme Customizer, Legal Pages, Subdomains, MCLogs Uploader, Fluffy Theme, Pirate Language), outlining features, usage, and configuration.

✏️ Tip: You can customize this high-level summary in your review settings.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/pelican-dev/plugins/pull/35 **Author:** [@PalmarHealer](https://github.com/PalmarHealer) **Created:** 12/21/2025 **Status:** ✅ Merged **Merged:** 12/23/2025 **Merged by:** [@Boy132](https://github.com/Boy132) **Base:** `main` ← **Head:** `palmarhealer/add-readmes` --- ### 📝 Commits (4) - [`8c7b4f8`](https://github.com/pelican-dev/plugins/commit/8c7b4f847caec1d8785f25ad17e35405de6bbe2a) Add READMEs for various plugins/themes, documenting features and technical details - [`5bcd52b`](https://github.com/pelican-dev/plugins/commit/5bcd52b051c35125e100a71f863094370ede81fc) Add additional notes and warnings to plugin READMEs - [`a3dbf9b`](https://github.com/pelican-dev/plugins/commit/a3dbf9b50e441904b5534c8f860a0ea179a11a0a) Remove technical details sections from plugin and theme READMEs. - [`c3fff9b`](https://github.com/pelican-dev/plugins/commit/c3fff9b5f004f1b033520282e030c87b90fd6d6d) cleanup ### 📊 Changes **20 files changed** (+234 additions, -135 deletions) <details> <summary>View changed files</summary> 📝 `README.md` (+28 -135) ➕ `announcements/README.md` (+14 -0) ➕ `billing/README.md` (+17 -0) ➕ `fluffy-theme/README.md` (+8 -0) ➕ `generic-oidc-providers/README.md` (+9 -0) ➕ `legal-pages/README.md` (+10 -0) ➕ `mclogs-uploader/README.md` (+9 -0) ➕ `minecraft-modrinth/README.md` (+13 -0) ➕ `pirate-language/README.md` (+13 -0) ➕ `player-counter/README.md` (+19 -0) ➕ `pterodactyl-theme/README.md` (+8 -0) ➕ `register/README.md` (+8 -0) ➕ `robo-avatars/README.md` (+9 -0) ➕ `rust-umod/README.md` (+9 -0) ➕ `snowflakes/README.md` (+9 -0) ➕ `subdomains/README.md` (+10 -0) ➕ `tawkto-widget/README.md` (+8 -0) ➕ `theme-customizer/README.md` (+9 -0) ➕ `tickets/README.md` (+10 -0) ➕ `user-creatable-servers/README.md` (+14 -0) </details> ### 📄 Description I thought this would be nicer since the main README stays very simple and the READMEs inside the plugins can be more comprehensive. and this system is very similar to https://github.com/pelican-eggs <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Reorganized main README into a concise, categorized bullet list (Plugins, Themes, Language Packs) and adjusted intro wording for consistency. * Added or updated documentation for 19 extensions and themes (e.g., Announcements, Billing, Player Counter, Tickets, Theme Customizer, Legal Pages, Subdomains, MCLogs Uploader, Fluffy Theme, Pirate Language), outlining features, usage, and configuration. <sub>✏️ Tip: You can customize this high-level summary in your review settings.</sub> <!-- end of auto-generated comment: release notes by coderabbit.ai --> --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
BreizhHardware 2026-05-07 00:17:57 +02:00
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
main
register/email-verification
No results found.
Labels
Clear labels   
pull-request
Mirrored from GitHub Pull Request

No labels
pull-request
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/plugins#78
No description provided.