Skip to content

feat(docs): abstraction support for documentation parsers #73

Open
@sudojunior

Description

@sudojunior

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

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).

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions