-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Framework for docs-only info #1556
Draft
ugtthis
wants to merge
9
commits into
commaai:master
Choose a base branch
from
ugtthis:docs-only-framework
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
github-actions
bot
added
car
related to opendbc/car/
body
chrysler
ford
gm
honda
hyundai
mazda
nissan
subaru
tesla
toyota
volkswagen
labels
Dec 4, 2024
Update: Will be going slightly in another direction. I continued this conversation in this Discord current-projects |
ugtthis
force-pushed
the
docs-only-framework
branch
3 times, most recently
from
December 18, 2024 04:57
8377254
to
3767116
Compare
ugtthis
force-pushed
the
docs-only-framework
branch
from
December 19, 2024 16:01
b3d6901
to
eaff28a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
In response to Adeebs message from PR #1478 .
I was originally going to do the NHTSA vin decoder route but then when I was searching through discord it seemed like the NHTSA vin decoder info can be a hit and miss for cars(refer to discord screenshots), and also doesn't include international cars. Though I think the
docs/data
will be able to make up for the missing/inaccurate NHTSA data over time. Below is what I'm thinking I will add.docs/data
: Acts as the grocery store and will house data from different sources, including:- NHTSA Vin Decoder API
- Data sources for international makes/models
- Data pulled from
values.py
-
opendbc-data
longitudinal reports- Other relevant sources as needed
docs/scripts
: Contains scripts for:- Fetching and organizing data from different sources.
- Parsing information from
values.py
to extract powertrain type and other metrics that are specific to certain car brands or makes./workflows/car_docs.yml
: A GitHub Actions file that:- Automates and triggers updates to the data pipeline.
- Ensures scripts are re-run regularly or on-demand to keep generated files up-to-date.
docs/generated
: Stores outputs like JSON files that:- Can be used directly in documentation.
- Provide data for other web experiences, such as a potential
opendbc.com
Had some things pop up recently which prevented me from continuing to work on this but will have more time this week. After thinking about your comment this is the general structure I'm thinking about going with so web experiences can get specific data in a better way