OAI / Overlay-Specification

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

Edit pass of readme and spec #75

Closed earth2marsh closed 1 month ago

earth2marsh commented 1 month ago

Feel free to reject any/all suggestions! My goal was simply to tighten up language wherever I thought I spotted an opportunity.

Note that the readme frames the intro and use cases slightly differently, which is either an opportunity to reconcile those somehow or an added dimension.

One small question... would it make sense to offer a recommended naming pattern for Overlay documents? I expect most will end with .yaml, but we might offer a way to identify Overlays from the file name without needing to introspect. For example: french-translation.overlay.yaml