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

Add vehicle selector and special notes for setup guide #25

Draft
wants to merge 31 commits into
base: master
Choose a base branch
from

Conversation

TheSecurityDev
Copy link
Contributor

@TheSecurityDev TheSecurityDev commented Mar 2, 2025

Add a vehicle selector to the setup guide, and a special notes card to dynamically show custom notes for specific models based on the setup_notes field on the data in vehicles.json.

Also does some refactoring and bug fixes to make this easier. For example, I had to refactor the harness selector to support only listing vehicles and not specific harnesses in some cases, since it doesn't make sense to show notes for a generic harness since there's no way to specify that in vehicles.json.

TODO:

  • The custom notes only support HTML, not markdown. But this can probably be implemented easily with a third-party library if necessary.
  • The custom notes will need to be created and added in opendbc, and then the vehicles_template.json can be modified accordingly.
  • Replace some of the currently hardcoded custom notes (e.g. GM and Nissan)

… clarification since some harnesses are developer only
Copy link
Contributor

github-actions bot commented Mar 2, 2025

deployed preview: https://comma-web--pr25-3735muh5.web.app

Welcome! Make sure to:

  • read the contributing guidelines
  • mark your PR as a draft until it's ready to review
  • post the preview on Discord; feedback from users will speedup the PR review

@TheSecurityDev
Copy link
Contributor Author

Example note:
image

@TheSecurityDev
Copy link
Contributor Author

TheSecurityDev commented Mar 4, 2025

Would this look better to have it horizontal in two columns? It seems like a lot of wasted space under the selector for larger notes though.
image
image
image

@TheSecurityDev
Copy link
Contributor Author

If we had different setup videos available for each make (and model if necessary) we could put the embedded setup video on the right column.

@TheSecurityDev
Copy link
Contributor Author

I'm not sure what else to do with this.

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.

1 participant