Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distinguish between aggregate & device properties #174

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Conversation

cjsha
Copy link
Member

@cjsha cjsha commented Dec 31, 2024

Resolve #171

image
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.

- Add content to configure.md
- Edit content on property-categories.md
@cjsha cjsha requested review from jonnew and bparks13 December 31, 2024 20:15
@jonnew
Copy link
Member

jonnew commented Jan 1, 2025

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:

image

@cjsha
Copy link
Member Author

cjsha commented Jan 2, 2025

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:

image                                      image

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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Inconsistancy in Devices versus acquisition, and configuration tags
2 participants