Guide for integrating with new device

[t-sasatani]

Hey @sneakers-the-rat , I'm working with @hsemwal to define new header structures for his new scope.
I didn't notice this in the PR review, but as this should be a unified starting point, could you write a quick guide? (For whatever set of tasks that will be necessary to interface this with a new device. Probably some docs under the device section?)

In particular, I need clarification about the intended interaction after #76 to set up the header structure (index) and port it into the stream_daq. The device parameter part (former device config YAML file) is clear through the discussion, but a guide will help anyway.

Sorry if I'm missing something; please point out where we should look in that case.

[sneakers-the-rat]

can do this :).

I think this should probably start with narrative documentation that describes the way that the header/stream config system works, right? and then we can walk through the stream daq as an example.

maybe what might be helpful for writing this is @hsemwal describing what is not clear trying to adapt from the code as you go along? - i know we just changed things up in #76 so pretty perfectly bad time to start a port right on the cusp, but the new structure should (i hope!) be a bit clearer since it's all id-indexed config files instead of half of them being instantiated models and the other half being yaml

[t-sasatani]

Thanks, we chatted a bit offline, but I think we need a device configuration guide starting with five short bullet points outlining what we should do (my opinion is that everything in a guide should be like that). A narrative doc could be something separate and linked to that.

Just something like the following. Even shorter would be better:

• If you want to make your own configuration you can plug in with id: custom_config, based on example_config, run the following commands:

> mio config [Some command for making user dir]
> mio config [Some command for copying an example_config to make custom_config]

• Then edit custom_config with text editor (I believe we don't have interfaces for this yet)

Related to this, I think the current guide -> configuration could be somewhere different like dev section or at least named differently like configuration system. It's pretty tough to require understanding the whole configuration system before configuring something.

[sneakers-the-rat]

Just something like the following. Even shorter would be better:

yep that's what i had in mind by narrative documentation.

Related to this, I think the current guide -> configuration could be somewhere different like dev section

agreed, should be split up with implementation details in the API docs. I think a "quickstart" or "getting started" page will settle the docs down a bit - very quick introduction, then there is a guide page with more user-facing details on configuration (and everything else), and then an API reference page with implementation details