search

COVESA / ifex

The Interface Exchange Framework. Tools for processing interface/API descriptions in different formats, including the IFEX core format. Some example files are at: https://github.com/COVESA/vehicle_service_catalog.
Mozilla Public License 2.0
14 stars 17 forks source link

Documentation #8

Open gunnarx opened 3 years ago

gunnarx commented 3 years ago

Write documentation using some appropriate generation tool.

Options

gunnarx commented 1 year ago

Update/related:

Work in progress to export the most technical documentation (i.e. exactly how the language is specified and the syntax rules that must be followed) is in #37.

Beyond that, this ticket is still valid for writing a more user-guide style documentation using an appropriate document generation tool.

gunnarx commented 1 year ago

For the moment, documentation is in plain Markdown. Keeping the ticket open for possible future improvements.