Skip to content

[DOCS]: Make Docmap Type more human readable #114

Description

@andrewedstrom

Documentation Request

Packages related to documentation request:

  • OWL/SHACL definitions
  • ts-sdk
  • ts-etl
  • spa

Description

I'm not sure if this is possible, but figured I'd mention it as a pain point.

When I view the Docmap type definition in the sdk documentation, this is what I see:

Screenshot 2023-09-26 at 12 01 18 PM

This is a pretty scary type definition and I find it hard to reason about. It would be nice to see something that looked more like a standard TypeScript type definition, or to see it annotated in a way that would make it easier to reason about piece-by-piece.

Additional information

N/A

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