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.
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
RFC:.