Vendicated / Vencord

The cutest Discord client mod
https://vencord.dev
GNU General Public License v3.0
8.75k stars 1.24k forks source link

Better document plugins #1383

Open Vendicated opened 1 year ago

Vendicated commented 1 year ago

As of now, plugins are pretty poorly documented. Beyond the basic description, you don't get more info / previews, so it's hard for users to understand what they're getting and how to use it

As such, we should add images & extended descriptions to all plugins

My idea is to restructure Vencord so that the structure looks something like so:

src/
    plugins/
        ViewIcons/
            banner.png
            index.ts
            README.me

Obstacles

TODO

lewisakura commented 1 year ago

banners

We definitely need to have some form of default, because plugins like APIs can't have a banner. Shiggy banner time. Because this just sucks.

This will cause merge conflicts in virtually every single PR as all plugins will have to be moved into folders

This doesn't seem like quite a big deal - merge bugfix PRs first for the plugin if applicable then move to folder. This way we should avoid the merge conflict issue. For new plugins, get them to move to the new system first. Then for plugins that don't need anything extended (e.g. APIs), then they can just stay bare and have some autofilled defaults. ezpz lemon squeezy

Besides that the proposal looks good to me. We already use folders for certain plugins so the loader can handle it easily enough.

muurt commented 9 months ago

Since documenting ~120 plugins is a pretty big task, we would likely have to make this a community effort, which means that we ask users to each document one plugin and then combine all these. Would have to think about this more and organise it properly

If it comes to writing README.md for each one of those plugins, I could write them myself, writing is fun after all! Also, would you have a layout for each README.md or? since without a layout things would probably get quite messy.