Docmaps-Project / docmaps

Extensible protocol for document history metadata exchange, to enable trustworthy, rapid, open science, by and for preprint science communities.
MIT License
15 stars 1 forks source link

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

Open andrewedstrom opened 1 year ago

andrewedstrom commented 1 year ago

Documentation Request

Packages related to documentation request:

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