Skip to content
This repository has been archived by the owner on Apr 5, 2024. It is now read-only.

Improve Documentation #59

Open
0xcaff opened this issue Aug 19, 2018 · 0 comments
Open

Improve Documentation #59

0xcaff opened this issue Aug 19, 2018 · 0 comments

Comments

@0xcaff
Copy link
Member

0xcaff commented Aug 19, 2018

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant