Open
Description
Documentation providers
Package | Planned | Supported | Website | Repository | Manifest |
---|---|---|---|---|---|
slash-create |
✅ | ✅ | slash-create.js.org | Snazzah/slash-create | Snazzah/slash-create@docs |
discord.js |
✅ | ✅ | discordjs.dev discord.js.org |
discordjs/discord.js | discordjs/docs |
eris |
❌ | ❌ | abal.moe/Eris | ~/data/docs/index.json |
~/eris-{version}.json |
@sapphire/* |
✅ | ❌ | sapphirejs.dev | sapphiredev/framework sapphiredev/shapeshift |
sapphiredev/docs |
Other providers not yet in scope
- https://github.com/twitterjs/twitter.js (docgen)
- https://github.com/zlddev/quickmongo (discordjs/ts-docgen)
Generator Formats
- typedoc
- ts-docgen (from typedoc)
- docgen
- openapi
By supporting slash-create
, dbots.js
and dbothook.js.org
are also supported and were added with the navigator rewrite in #70. Per-package embed libraries are already possible, .
Additional safeguards to protect the service from throwing errors can include prevention of attempts to search or fetch from specific providers for /docs
or /code
as standard options or an opt-in basis. Navigator abstractions will also be needed due to the differences in docgen structure (i.e. SlashCreateDocsParser
+ SlashCreateDocsSource
+ SlashCreateDocsNavigator
).