Documentation for plugin system

chris48s / v8r

✔️ A command-line JSON, YAML and TOML validator that's on your wavelength

https://chris48s.github.io/v8r/

MIT License

28 stars 5 forks source link

Documentation for plugin system #483

Closed chris48s closed 3 weeks ago

chris48s commented 1 month ago

This might require a bit of a restructure of the docs - you've probably outgrown a single markdown file at this point:

Interface + plugin tutorial
Semver compatibility statement
Add JSDoc comments to BasePlugin
Changelog
Anything else? General review of docs

chris48s commented 1 month ago

As well as how to write plugins, you need to cover how to load/consume them as a user. This includes config file changes. Also, how will plugins (not) work when invoking via npx instead of a local install?

chris48s commented 1 month ago

Finish https://github.com/chris48s/v8r/pull/486 first. Then once that is in, adding a bunch more docs will be way easier. The single markdown file had got a bit big for its boots.