databroker icon indicating copy to clipboard operation
databroker copied to clipboard

suggested additions to documentation of API versions

Open dylanmcreynolds opened this issue 1 year ago • 1 comments

From a conversation on nakea slack, I would love to highlight the differences between the databroker API version and the databroker software version. Furthermore, the documentation on API versions does not quite capture the differences between the API v2 and the tiled-supported version of databroker, which I think is like v2 but with different initialization.

Description

I added to the main table of API version the version of databroker software supported. I also tried to highlight the subtlety of API v2 and v2 with tiled. If this approach to the documentation is deemed worthy, we should also an initialization example, for which this PR currently only adds a placeholder.

dylanmcreynolds avatar Dec 05 '22 21:12 dylanmcreynolds