You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.
Currently, the documentation isn't consumed by any tools. This allows the documentation to be a wild west of arbitrary // and /* */ and /** */ comments with non-standardized conventions.
Solution
Go through the documentation and make it satisfy the tsdoc specification so it can be used with tools like react-docgen-typescript, TypeDoc and styleguideist.
Let's start by converting existing documentation to something which looks nice in TypeDoc. Let's make documentation look good in IDEs quick view first, the figure out if and how we should make it accessible outside the code base.
The text was updated successfully, but these errors were encountered:
Problem
Currently, the documentation isn't consumed by any tools. This allows the documentation to be a wild west of arbitrary
//
and/* */
and/** */
comments with non-standardized conventions.Solution
Go through the documentation and make it satisfy the
tsdoc
specification so it can be used with tools likereact-docgen-typescript
, TypeDoc and styleguideist.Let's start by converting existing documentation to something which looks nice in TypeDoc. Let's make documentation look good in IDEs quick view first, the figure out if and how we should make it accessible outside the code base.
The text was updated successfully, but these errors were encountered: