[Idea]: refactor generated TypeScript interface documentation #20
Labels
difficulty: 3
Likely to be challenging but manageable.
idea
Potential GSoC project idea.
priority: normal
Normal priority.
tech: html/css
Involves using HTML and CSS.
tech: javascript
Involves programming in JavaScript.
tech: jsx/react
Involves programming with React JSX.
tech: nodejs
Requires developing with Node.js.
tech: typescript
Involves programming in TypeScript.
Idea
Currently, stdlib publishes TypeScript interface documentation in its web-based API documentation. The generated documentation monkey-patches
tsdoc
to handle generating documentation across the entire mono-repo. The goal of this project is to refactor/rethink this approach and provide a solution capable of addressing the unique constraints of the stdlib project.Expected Outcomes
At a base level, it would be great if we had a working documentation render which did not require monkey-patching. A more difficult, but potentially more desirable, outcome would be if TypeScript documentation was not rendered as a separate website, but rather was integrated within the docs as simply another page/fragment.
Involved Software
No other software is necessary.
Prerequisite Knowledge
JavaScript, Node.js, HTML/CSS, TypeScript, JSX/React.
Difficulty
Intermediate.
Project Length
175/350 hours. Length will depend on the nature of the proposed solution (e.g., needing to write a custom TypeScript parser vs modifying the existing tsdoc library).
Potential Mentors
@kgryte @Planeshifter @steff456
The text was updated successfully, but these errors were encountered: