Schema

The Road Map file format is defined in a JSONSchema schema which includes all of the supported fields and examples of their use. Many modern editors, including VS Code include support for using JSONSchema files to provide in-editor suggestions and validation.

You'll find the schema itself hosted on schemas.sierrasoftworks.com and you can directly reference it in your editor using the URL below.

https://schemas.sierrasoftworks.com/roadmap/v1/schema.json

Using the Schema

VS Code

If you have installed the YAML extension for Visual Studio code, you can add the # yaml-language-server directive to set the schema.

# yaml-language-server: $schema=https://schemas.sierrasoftworks.com/roadmap/v1/schema.json

roadmap.schema.json