guidelines icon indicating copy to clipboard operation
guidelines copied to clipboard

Provide markup examples and illustrations within elementSpec

Open bwbohl opened this issue 6 years ago • 1 comments

Adding this from closed issue in music-encoding/music-encoding, cf. https://github.com/music-encoding/music-encoding/issues/222

bwbohl avatar Jul 31 '19 08:07 bwbohl

As mentioned in music-encoding/music-encoding#222 and obvious from the guidelines repo being separated from the schema development it is questionable whether to include code examples in the schema definition, nevertheless the guidelines and/or specs should provide examples and potentially even more than in the text-flow. Maybe the best way would be to run a query of all examples in the guidelines as well as over all https://github.com/music-encoding/sample-encodings and display the results at the end of the respective element spec

bwbohl avatar Mar 11 '20 08:03 bwbohl