[Feature Request] Better documentation

[Vendicated]

Discord Account

vindicated vendicated

What is it that you'd like to see?

Currently the available apis aren't really documented well. Besides jsdoc there's not much to go off, other than looking at how other plugins do it. This applies to both apis in the api/ folder and for other apis such as webpack search, webpack commons (describing every discord module is definitely overkill but maybe more general) and the most common utils like LazyComponent, ErrorBoundary and when to use it (always), useAwaiter etc

It would be nice to have documentation for each api that

• outlines what use cases this api covers and what features it offers
• outlines the api signature (aka typescript types, what parameters or options it accepts,...)
• shows at least one example for each use case

Note though that documentation will soon be moved to a new home at Vencord/Website (heavy WIP) so it should be contributed there once a basic structure for documentation is established (it will be done via markdown files)

Request Agreement

• This is not a plugin request