search

ipld / specs

Content-addressed, authenticated, immutable data structures
Other
592 stars 108 forks source link

tombstones for schema docs #374

Closed rvagg closed 3 years ago

rvagg commented 3 years ago

have also put # .. and {"error":"..."} into .ipldsch and .json docs

willscott commented 3 years ago

I am fond of having less replicas of this information

we need a canonical raw instance of these files for use in APIs. that needs to be clearly and easily available. The PR in this form doesn't do that.

warpfork commented 3 years ago

We have a canonical raw instance of these files.

It's https://github.com/ipld/ipld/blob/master/specs/schemas/schema-schema.ipldsch.json .

The linking in the website generation was broken. I'm fixing that in https://github.com/ipld/ipld/pull/116 .

rvagg commented 3 years ago

OK so I've been specific in the redirects for .ipldsch and .ipldsch.json documents to their actual counterparts on ipld.io. I have left the others general, like I did for the CAR redirect, simply to give us flexibility to reorganise things over there and not have to come back here to fix up links every time we might do a minor shuffle. I'd rather we not shuffle (and am still not enthused about any of this stuff moving, but whatever) and keep stable URLs, but I think we've proven as an org that we're not super good at that kind of stability (maybe we just need to point to CIDs of these things instead).

Thoughts?