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

Format update for new Component Picker #186

Merged
merged 21 commits into from Oct 31, 2023
Merged

Format update for new Component Picker #186

merged 21 commits into from Oct 31, 2023

Conversation

lorennorman
Copy link
Contributor

@lorennorman lorennorman commented Oct 16, 2023

We've got a new Component picker design to support!
image

Big changes to all Components:

  • new properties: vendor, description, productURL, documentationURL
  • no more animations (already removed the files and validators in this PR)
  • images:
    • are now optional as files in the repo
      • if no image file but an Adafruit productURL is present, will be auto-fetched from Shop on import
    • are now validated 4:3 instead of square (matching Adafruit shop product images)
      • old images won't fail validation until they're touched, but will be "squeezed" on the web

Data to add:

  • vendor: required, use "generic" as appropriate
  • productURL:
    • we should have this on all of our components, at least
    • delete the image file for any components where the first product image on Shop is good (ie not a movie)
  • documentationURL: link to a Learn Guide for this component, as appropriate
  • description:
    • BRIEF overview of the component, about 100 characters will be visible, up to 255 can be shown on mouse over
    • these can be formulaic, list of sensors and such, no need to get clever (at least not right now)
    • I'm ambivalent about requiring this, may be able to auto-generate something serviceable on my side as a default

/cc @tyeth

@brentru
Copy link
Member

brentru commented Oct 19, 2023

@tyeth The vendor field should be who makes the sensor, not the breakout. It can be generic for components like Servo, LED, Button, etc..

@lorennorman lorennorman merged commit 9d8362c into main Oct 31, 2023
13 checks passed
@lorennorman lorennorman deleted the shop-integration branch October 31, 2023 20:08
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.

None yet

3 participants