Worked examples

We could consider creating a supplementary document (or a set of documents) that demonstrates the implementation of the string-meta pattern across various popular data formats. This would lower the barrier to adoption.

Developers of target specifications would be able to visualize at a glance how to apply the string-meta pattern within the context of their own specific formats.

One potential approach is adding a set of example files and a corresponding guide page. This could be accomplished by introducing an examples/ directory. For example, its might include:

• examples/json/ — A JSON Schema definition file demonstrating the usage of the value/lang/dir pattern, language maps, and document-level default values.
• examples/yaml/ — A corresponding YAML example file (illustrating how the same set of patterns maps onto the YAML format).
• examples/protobuf/ — A corresponding .proto definition file.

And an examples.html page could be created to walk through the examples for each of the formats, with links directing back to the relevant sections within string-meta.

Review the string-meta pattern and the relevant specification sections first, then determine which data formats and examples are in scope. Done means the chosen examples are added under an examples/ directory and an examples.html guide explains them with links back to the relevant string-meta sections.