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.

Sign up for GitHub

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

Jump to bottom

docs: CARS.md 2.0 #1286

Closed
wants to merge 46 commits into from
Closed

docs: CARS.md 2.0 #1286

wants to merge 46 commits into from

Conversation

jyoung8607
Copy link
Collaborator

@jyoung8607 jyoung8607 commented Sep 26, 2024 •
edited
Loading

Resolves #1144 by introducing other_cars.py, allowing us to generate CarDocs for cars outside of openpilot. This is WIP and still a bit trash, but illustrative enough to start the bikeshedding.

Direct links to view the work in progress

TODO

  • Move generation to opendbc, but save output in openpilot (?)
    • Unwind development-only move of CARS.md and assets just before shipping
  • Verify this doesn't hurt any comma.ai/vehicles or shop.comma.ai flows
  • Make other-than-official cars much more visually obvious (background color, italics, ?)
  • Cleanup/revamp the template text in accordance with the New Way of Things
  • Remove placeholder "dashcam mode" support logic, replace with the actual reason they're in dashcam mode
  • Out-of-tree cars should show N/A for other characteristics
  • Some complex footnotes should become intra-document #links
  • Internal discussion about links to forks
  • Resolve other TODOs
  • Cleanup
  • Tests for new support type logic

@github-actions github-actions bot added the car related to opendbc/car/ label Sep 26, 2024
@github-actions github-actions bot added the body label Sep 27, 2024
@github-actions github-actions bot added the ford label Sep 28, 2024
@jyoung8607 jyoung8607 mentioned this pull request Sep 28, 2024
Merged
adeebshihadeh
adeebshihadeh reviewed Oct 2, 2024
View reviewed changes
Copy link
Contributor

@adeebshihadeh adeebshihadeh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

other_cars.py looks great!

opendbc/car/docs_definitions.py
@@ -24,6 +25,16 @@ class Column(Enum):
VIDEO = "Video"


# TODO: Bikeshed this enum, lines between custom fork and dashcam are blurry, and not sure about legacy support
class SupportType(Enum):
OFFICIAL = "Official"
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"official" is a pretty loaded word, let's go with "upstream"

@jyoung8607 jyoung8607 mentioned this pull request Oct 2, 2024
Closed
2 tasks
@jyoung8607 jyoung8607 closed this Oct 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adeebshihadeh adeebshihadeh adeebshihadeh left review comments

Assignees
No one assigned
Labels
body car related to opendbc/car/ ford volkswagen
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

New car support docs
2 participants
@jyoung8607 @adeebshihadeh