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

Follow up on website documentation #231

Merged
merged 19 commits into from
Nov 2, 2023
Merged

Conversation

guilhermedemouraa
Copy link
Contributor

No description provided.

@guilhermedemouraa guilhermedemouraa changed the title Concepts - Canbus Service Overview Follow up on website documentation Oct 31, 2023
Copy link
Collaborator

@Hackerman342 Hackerman342 left a comment

Choose a reason for hiding this comment

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

I think we're stretching a bit on the required background knowledge. For the really simple examples, I think it's OK if the only requirement is basic familiarity with python / running python scripts from the command line. Let's keep it minimal and essential. IMO things like 'File Handling' and 'Log File Manipulation' are captured in basic Python familiarity.

Keep in mind the motivation of these sections is so that someone doesn't get halfway through an example and realize they're way in over their head.

If we want to add a "potential further reading" or something like that I'm not against it, but for example knowledge of CAN protocols is not required parse the messages that happen to have been communicated to the brain via CAN bus.

website/docs/examples/events_recorder/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader_gps/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader_gps/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader_can/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_converter/README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@Hackerman342 Hackerman342 left a comment

Choose a reason for hiding this comment

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

There's a lot missing about on canbus service concepts page, but I can expand on that after we are done with the release

website/docs/concepts/canbus_service/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_converter/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader_gps/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader_can/README.md Outdated Show resolved Hide resolved
website/docs/examples/file_reader/README.md Outdated Show resolved Hide resolved
website/docs/examples/events_recorder/README.md Outdated Show resolved Hide resolved
guilhermedemouraa and others added 8 commits November 2, 2023 13:50
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
Co-authored-by: Kyle Coble <53625197+Hackerman342@users.noreply.github.com>
@guilhermedemouraa guilhermedemouraa merged commit aa3e2b1 into main Nov 2, 2023
2 checks passed
@guilhermedemouraa guilhermedemouraa deleted the follow-up-services branch November 2, 2023 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants