Distinguish between aggregate & device properties #174
Conversation
- Add content to configure.md - Edit content on property-categories.md
|
This looks very good. Better than original idea. I think maybe the word "aggregate" is a bit scary. Which is why Cris originally came up with "MultiDeviceFactory". So I might want to change that. Also "aggregate" is an adjective, noun, and verb! So its confusing in this sense as well. Maybe "Device Group" Another note -- is there a reason these are lowercased? I think they should be uppercase: "Device", "Acquisition", etc. re Red = bad: yeah thats true. I think we just need to design some more colors. For instance, orange and green like is used in RP2040 docs that I happen to be looking at: 
|
|
I was originally limiting myself to these colors but I saw how bootstrap generates an alert's background color, border color, and text color (and their dark versions) from a given base color so I expanded the available color palette. For example:
Those are all the badges I foresee being used in these docs and my proposal for their colors but we can make more colors if we need to. Currently "Configuration" is yellow, but I think opposing labels should oppose on the primary/secondary color wheel so I switched it to orange in the above screenshot. Fixed-rate and variable-rate refer to "event-based" and "streaming" data operators in #98. |
- capitalize badges - "Aggregate" -> "Device Group" - hard wrap 100 characters instead of 120
|
These badges look great. @cjsha and I discussed the Fixed and Variable rate badges IRL and realized that it might be difficult to maintain since they would need to be manually added or we would need to make up an attribute for data operators and apply that in the source code. Both sound clunky. Additionally, at the end of the day, from the API's perspective and in Bonsai, there is only variable rate data because everything is asynchronous. So, lets couch that for now. In the meantime, I would replace the red device color with the nice purple from the the proposed variable rate tag. |
| configure ONIX hardware hubs. These are known as device group configuration operators because they configure an aggregation |
There was a problem hiding this comment.
"configure an aggregation" -> configure a group
| configure ONIX hardware hubs. These are known as device group configuration operators because they configure an aggregation | ||
| of devices (also referred to as a hardware hub) on a given headstage, miniscope, breakout board, etc.. |
There was a problem hiding this comment.
dont use hub, its a specification term.
| of devices (also referred to as a hardware hub) on a given headstage, miniscope, breakout board, etc.. | ||
|
|
||
| Aggregate configuration operators are simply referred to as "Configuration Operators" in the |
|
|
||
| Aggregate configuration operators are simply referred to as "Configuration Operators" in the | ||
| [Reference](xref:OpenEphys.Onix1) TOC for concision and simplicity as they are recommended starting-point operators for |
|
i tried ddg on my machine without changing anything and the badge colors show. if you update, does it work? the problem might be something else.
|
Resolve #171
The space between the header and the badge for a hyperlink to appear when hovering the cursor there.
Something I don't like from this initial commit is that I have red and green badges to distinguish between acquisition and device properties. I'm worried that there is an instinctual heuristic that red = bad and green = good that I don't want to evoke from people skimming our docs. I can use different colors, but we might want to reserve two colors to for badges when attempting a solution for #98.