multiformats / multicodec

Compact self-describing codecs. Save space by using predefined multicodec tables.
MIT License
340 stars 204 forks source link

Options for adding docs and test fixtures for multicodec entries #240

Open rvagg opened 3 years ago

rvagg commented 3 years ago

In the space of a few weeks we have two separate discussion about needing a place to define entries in the multicodec table, including test fixtures:

We don’t really have such a space currently. Some options:

At this stage I'm inclined to consider the last option - just do it in the repo, no web frontend, encourage the use of testmark for fixturing but not be too restrictive in formats or content of a "specification" initially but let that evolve over time.

warpfork commented 3 years ago

Options there or four sound good to me, followed by one followed by two. Really, they're all valid.

I agree with the observation that a fancy web frontend is probably quite optional. Especially if we use a format for fixtures (markdown/testmark) that already renders well on github.

If we chose to put things in the ipld repo and site: I'd probably suggest that we exclude all but an index entrypoint page from the nav sidebar, but that's certainly fine (we do this for some high-detail content already).