Skip to content

Some docs that would be useful! #224

Description

@gitKrystan

Currently I am most confused about the <APIDocs /> component.

  1. It looks like the <Page /> component magically infers what package you are looking at from the URL but there is no similar feature for the APIDocs component, and the docs aren't super clear about how I would go about doing that.
  2. This comment led me to believe the APIDocs support would JustWork with JSDoc.
    It wasn't until here that I realized I might need to set up typedoc. And TBH I didn't find that until I'd been poking around in the runtime and managed to trigger an error that indicated I need to do some sort of typedoc configuration.
  3. No docs for the services, and I think I might need to use the services to resolve my confusion about 1 above, but maybe not?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Fields

    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions