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

New car support docs #1144

Open
adeebshihadeh opened this issue Jul 20, 2024 · 3 comments
Open

New car support docs #1144

adeebshihadeh opened this issue Jul 20, 2024 · 3 comments
Labels
car related to opendbc/car/ docs enhancement

Comments

@adeebshihadeh
Copy link
Contributor

adeebshihadeh commented Jul 20, 2024

This is v2 of CARS.md. Currently, CARS.md shows all the cars supported by upstream openpilot. The goal of this new page is to be a one stop shop to see the status of any car's support.

It'll include:

  • every single car: cars supported in upstream, dashcam cars in upstream, cars supported in forks (even if they're forever in forks), cars we know won't work (no ACC/LKAS), cars with blockers (SecOc), etc.
  • super granular columns: has fuzzy fingerprinting, steering torque, etc.
  • some info will be populated by openpilot, and the rest will be done manually

This will be super information dense, so I imagine we'll need to move this to a webpage instead of a GitHub Markdown file.

These docs should also help make it clear when a car port is ready to supported and merged into upstream openpilot.

Related:

@adeebshihadeh adeebshihadeh added enhancement docs car related to opendbc/car/ labels Jul 20, 2024
@adeebshihadeh adeebshihadeh changed the title New support car docs New car support docs Jul 20, 2024
@andiradulescu
Copy link

Does this invalidate commaai/openpilot#32690?

@adeebshihadeh
Copy link
Contributor Author

No

@adeebshihadeh adeebshihadeh transferred this issue from commaai/openpilot Aug 20, 2024
@jyoung8607 jyoung8607 mentioned this issue Sep 26, 2024
12 tasks
@jyoung8607
Copy link
Collaborator

The new opendbc/docs/CARS.md from #1338 is a substantive step toward these goals, just for adding support info to upstream dashcam cars, adding CarDocs for community-supported cars that aren't upstream, and adding CarDocs for cars that are known to be fundamentally incompatible.

This issue remains open because the markdown output is basically a shippable intermediary. To become as information-dense as the openpilot team would like, the new CarDocs infrastructure really needs to be rendered by a web app.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
car related to opendbc/car/ docs enhancement
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants