-
Notifications
You must be signed in to change notification settings - Fork 453
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
Add Apollo Automation Devices #638
base: main
Are you sure you want to change the base?
Conversation
✅ Deploy Preview for esphome-devices ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking good so far! I left a few comments about some minor styling stuff, but I didn't find anything that needed a major correction. You may want to call out the optional sensors in the list of components for clarity, though. Ex:
- (Optional) MiCS-4514 ...
Reading through some other device pages, it looks like Github-flavor markdown is generally supported. If you're looking for ideas for styling, there's a good doc available here
|
||
[YouTube](https://www.youtube.com/@ApolloAutomation) | ||
|
||
![Apollo AIR-1](Apollo-AIR-1.jpg "Apollo AIR-1") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'd suggest putting one of the product images at the top so that it displays above the fold for people just browsing through device lists.
Keeping the rest at the bottom seems fine to me, though. But maybe add a "Product Images" header so that it shows up as a quick navigation option:
## Product Images
![Apollo AIR-1](Apollo-AIR-1.jpg "Apollo AIR-1")
|
||
[YouTube](https://www.youtube.com/@ApolloAutomation) | ||
|
||
![Apollo MSR-1](Apollo-MSR-1.jpg "Apollo MSR-1") |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Same suggestion here: move one of the images above the fold, and add a Product Images header for any others that are added.
project-url: https://github.com/ApolloAutomation/AIR-1/blob/main/Integrations/ESPHome/AIR-1.yaml | ||
difficulty: 1 | ||
--- | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Adding headers (## Header Text
) to your markdown will generate quick navigation links on the right side (for desktop browsers) and allow linking to each section by hash/location keys. Possible headers based on the current markdown content might be:
Description
The Apollo Automation AIR-1 is an air quality sensor with (...)
Components
(...)
External Links
(...)
|
||
The Apollo Automation AIR-1 is an air quality sensor with the following features: | ||
|
||
- SEN55 PM1, PM2.5, PM4, PM10, VOC, NOx, Temperature and Humidity |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For the sensor list, I think it'd be cool to link to the ESPHome documentation for that specific sensor. Another option would be an official product page or datasheet, but I think the ESPHome implementation details for that sensor would be more relevant.
Just a thought, though!
difficulty: 1 | ||
--- | ||
|
||
The Apollo Automation MSR-1 is a mmWave CO2 multisensor with the following features: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(same suggestion as above regarding headers for distinct sections for readability/navigation)
No description provided.