spec icon indicating copy to clipboard operation
spec copied to clipboard

[Discovery] add small example before we dive deep

Open duglin opened this issue 5 years ago • 1 comments

In this section: https://github.com/cloudevents/spec/blob/541e790ef8076f889adfe7a82859f815ec80d22c/discovery.md#entities-in-the-api I like that we give a short overview, in words, of how to view the "directory". I wonder if it would help readers if we then provided a VERY small example (even if it has lots of ... to hide some output) of what a query result would look like before we start the next section? This might help the reader mentally picture the entities and how they are related/grouped before we dive deep with the list of entities.

duglin avatar May 07 '20 12:05 duglin

Even a psuedo-schema that shows the outline of the directory would be good.

duglin avatar May 07 '20 15:05 duglin

Moved to https://github.com/xregistry/spec/issues/3

duglin avatar Apr 18 '23 20:04 duglin