Document the required structure of specifications

open-feature / spec

OpenFeature specification

https://openfeature.dev

Apache License 2.0

656 stars 34 forks source link

Document the required structure of specifications #7

Closed beeme1mr closed 2 years ago

beeme1mr commented 2 years ago

What are you trying to achieve?

OpenFeature specifications need to be well structured and easy to understand. W3C has a QA framework for specification guidelines that may be useful for standardizing the spec. OpenTelemetery also had a PR that automatically extracted properly formatted specs into JSON.

No matter what approach is chosen, it should be documented so the spec remains consistent.

toddbaert commented 2 years ago

Closed. This is captured in current doc/spec, and we have an issue for some automation: https://github.com/open-feature/spec/issues/36.