Repository navigation
docs: ✏️ Say in the README that the project also teaches the system's architecture - #222
Merged
Merged
Conversation
… architecture Learning how the stages connect into one autonomous driving system, not only single algorithms, is what sets the project apart from algorithm collections. The README now says so, links the architecture document, and says that the code is still moving toward that design. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This file contains hidden or 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
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.
Change
Besides the algorithms, the project teaches how they connect into one autonomous driving system. This is what sets it apart from algorithm collections, and the README now says so.
First paragraph: the open textbook covers the self-driving car algorithms "and the software architecture that connects them into one autonomous driving system".
About this project, second paragraph: what the architecture part teaches:
It also says that the code is still moving toward this design (
ARCHITECTURE.mdis a proposal, implemented in Phase 2 of Roadmap: toward a full navigation simulator for learning #131, Phase 2: NavigationStack, Frame and Trajectory #115), so the README doesn't promise more than exists today.The book's description and the social preview image keep the algorithm names first, since those are the words people search for (#216).
🤖 Generated with Claude Code