Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[RFC]: add support for viewing API docs as JSON #27

Open
3 tasks done
kgryte opened this issue Sep 10, 2021 · 0 comments
Open
3 tasks done

[RFC]: add support for viewing API docs as JSON #27

kgryte opened this issue Sep 10, 2021 · 0 comments

Comments

@kgryte
Copy link
Member

kgryte commented Sep 10, 2021

Description

This RFC proposes adding support for viewing API docs as JSON.

Currently, one can only view the API docs as HTML. Would be nice to be able to view the docs as JSON, as well, similar to Node.js (e.g., see console).

This would be useful as a consumable public format which can be consumed by IDEs and code editors.

Accomplishing this feature would require some tooling, as we'd like want to incorporate type information, which is not readily available in the README files, but is present in both the repl.txt (where present), in the TypeScript declaration files, and in the JSDoc source comments.

Related Issues

No.

Questions

No.

Other

No.

Checklist

  • I have read and understood the Code of Conduct.
  • Searched for existing issues and pull requests.
  • The issue name begins with RFC:.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant