pulquero / RotorHazard

Multi-node video transmitter race timer for drone racing
Other
6 stars 0 forks source link

Finish config.schema.json #63

Open martinglass opened 3 years ago

martinglass commented 3 years ago

Schema files have been created but need to be populated further.

For example, config.schema.json describes what is allowed in config.json

This issue is being raised to request help from people to finish config.schema.json, to provide config file validation and documentation.

In that way docs can be auto generated from it.

pulquero commented 3 years ago

This file https://github.com/pulquero/RotorHazard/blob/BetaHazard/src/config.schema.json defines the expected structure of config.json. You should be able to notice that it already contains definitions for some of the config properties. The best example is LOGGING.CONFIG_FILE, it defines what type the property is and a description for documentation. The most minimilist example is GENERAL.SECONDARIES, nothing about it is defined, only that it should exist.

martinglass commented 3 years ago

Thanks - I'll take a look later