Better document plugins

[Vendicated]

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

• banner.png: will be displayed in plugins cards both in client and on https://vencord.dev/plugins - must match [to be determined dimensions (for example 16x9)]
• README.md: contains an extended description that will be displayed both in client in plugin modals and on https://vencord.dev/plugins/ViewIcons. Here, more info and guidance on the plugins should be provided

Obstacles

• This will cause merge conflicts in virtually every single PR as all plugins will have to be moved into folders
• 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

TODO

• Redesign Vencord plugin cards to add banner image. Also figure out good dimensions in this step
• Redesign the Vencord plugin modal to render markdown content. This can likely just use Discord's parser. Hyperlinks ([hi](https://...)) and images (![cool image](https://image.com)) should work. The former should already be possible with Discord's parser, the latter would need to be implemented manually
• Redesign the https://vencord.dev/plugins cards to add banner images
• Redesign the https://vencord.dev/plugins/ViewIcons page to render markdown content. Same conditions as in step 2 apply
• Start working on collecting banners and extended descriptions for plugins. This could probably best be automated via Vaius
• Lastly, migrate all plugins to folders and add the new banners & READMEs

[lewisakura]

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]

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.

[korbosoft]

Are we still working on this? I'd be willing to help

[korbosoft]

did a shit ton of them, see #3061