Skip to content

Add links to documentation to JSDoc #2

@danieldietrich

Description

@danieldietrich

Use case: Lower the bar for entry level users and experienced users of typelevel to learn the API.

Benefits: have the docs in a central place.

Example:

+ // See https://docs.typelevel.io#ValidationError
export type ValidationError<Message extends string = any, Cause = unknown, Help = unknown> =
    Join<{ message: Message } & Map<Cause, { cause: Cause }> & Map<Help, { help: Help }>>;

Metadata

Metadata

Assignees

No one assigned

    Labels

    ✍️ doc... is more precious than code!

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions