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

docs: CARS.md 2.1 #1338

Merged
merged 27 commits into from
Oct 4, 2024
Merged

docs: CARS.md 2.1 #1338

merged 27 commits into from
Oct 4, 2024

Conversation

jyoung8607
Copy link
Collaborator

@jyoung8607 jyoung8607 commented Oct 3, 2024

Design goals

  • Preserve openpilot CARS.md location/behavior, supported cars only
  • Start generating a new, separate CARS.md in opendbc
  • opendbc's CARS.md will have less detail, but include many more cars
  • don't break the website or the shop

Preview

To-do

  • "atypical install" or something instead of "legacy", will include SecOC

@github-actions github-actions bot added the car related to opendbc/car/ label Oct 3, 2024
@github-actions github-actions bot added the ford label Oct 4, 2024
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.

The classes don't feel quite right to me, but seems fine to start with. The infra and presentation look great.

@github-actions github-actions bot added the gm label Oct 4, 2024
@jyoung8607 jyoung8607 marked this pull request as ready for review October 4, 2024 06:05
@jyoung8607 jyoung8607 merged commit 9bf735b into commaai:master Oct 4, 2024
4 checks passed
@jyoung8607 jyoung8607 deleted the extra-cars3 branch October 4, 2024 06:06
@sshane
Copy link
Contributor

sshane commented Oct 4, 2024

Would a link to the under review PR be a good idea?

@jyoung8607
Copy link
Collaborator Author

I wrote the support link stuff with the idea we could override the link target, for any entry, to something outside the doc. A comma PR, a fork repo, something at docs.comma.ai, whatever. Or, we can make it a footnote style link, or whatever seems reasonable as we go.

Unrelated note, will hook up CI tests tomorrow AM to make sure new CARS.md is always up to date, same as openpilot.

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

Successfully merging this pull request may close these issues.

3 participants