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

Improve Documentation #59

@0xcaff

Description

@0xcaff

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions