-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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
docs: CARS.md 2.1 #1338
Conversation
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.
The classes don't feel quite right to me, but seems fine to start with. The infra and presentation look great.
Would a link to the under review PR be a good idea? |
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. |
@jyoung8607 is there any reason we can't merge these car infos into their respetive brands? this adds some extra complexity and would be nice if we didn't need special handing in docs.py |
Adeeb wanted to eventually document ALL cars. We don't have brand directories for, say, BMW or Mercedes. Additionally, a lot of the non-support reasons were shared between makes and seemed to make sense to collect together. For example, all cars unsupported due to Flexray could use a common Flexray doc platform, all cars with (unmitigated) SecOC could use one SecOC doc platform, etc. For those brands where we do have some existing support, a case could be made to move those definitions to the brand. I'd have to see how it looks and if code changes are needed. |
Design goals
Preview
To-do