Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
rvagg opened this issue Nov 4, 2021 · 1 comment
Open

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

rvagg opened this issue Nov 4, 2021 · 1 comment

Comments

@rvagg
Copy link
Member

rvagg commented Nov 4, 2021

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:

  • We have https://multiformats.io which is currently just a very simple static 3 page site - hasn’t been touched in a year and uses Hugo. It'll probably need some work to make it easier to hold specs and fixture data, including moving off Hugo.
  • We have https://ipld.io which is much more actively maintained and we’re shoving test fixture data into it these days too (mainly using testmark). The problem here is that even the above two entries push uncomfortably at the definitional scope of "IPLD" - do either of those really belong on an IPLD site?
  • We have this repo, which we could just add a new directory to "specs" which contains a directory for each new spec we want to add, and not worry about fancy web frontends.
  • We have https://github.com/multiformats/specs which contains some initial drafts of general multiformats IETF specs (to define multihash, multiaddr, multibase etc.) that we wanted to propose (we still need to do this but the work is a bit stale!). We could expand the scope of that repo to allow it contain arbitrary specifications for any entry in this table that doesn't have a logical home elsewhere for a specification.

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
Copy link
Contributor

warpfork commented Nov 4, 2021

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).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants
@rvagg @warpfork and others