Skip to content

api documentation cleanup #169

Description

@mighdoll

There is now some TypeDoc generated documentation for wesl-js available at js.wesl-lang.dev.

The audience for this kind of doc is advanced users embedding wesl-js as a library, or developers writing wesl-js extensions.

Do a cleanup pass and file issues for future work:

  • Review the tsdoc annotations and/or package references to remove private stuff from the public docs.
  • Fix the top level and package level readme files.
  • include the wesl-plugin in the docs
  • Consider adding grouping and highlighting, e.g. start with the link() api.
  • Consider additional plugins for typedoc: plugins
  • some ideas here: blog post

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    Status
    Unprioritized

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions