search

OAI / Overlay-Specification

The OAI Overlay Specification
Apache License 2.0
60 stars 15 forks source link

Add `examples` directory #82

Closed earth2marsh closed 1 hour ago

earth2marsh commented 1 month ago

As a tooling developer looking to implement overlays, I would like to have at least one example of a well-formed overlay, original description document, and a merged result. Today I would have to build my own examples from the in-line examples of the Overlays Specification.

Here is a quick gist that shows what I mean: https://gist.github.com/earth2marsh/51689e3b93d1140dec75a381fa9989ef

(and happy to add this directory and files via a PR if that helps!)

handrews commented 1 month ago

We recently decided to remove the examples directory from the OAS repo, and we should align with that for Overlay. It was a problem to have our GitHub directory and branch structure be part of our "public" interface.

Please instead update the specification to point to the Learn site, which is where we moved the OAS examples (which are now rendered nicely and can have commentary with them as well!)

lornajane commented 1 hour ago

I'm closing this request in favour of adding documentation to the learn site. The work in #99 might also be interesting/relevant.