Repository navigation
docs: 🎨 Refresh the README's first screen and add a social preview image - #220
Merged
Merged
Conversation
Most visitors decide from the README's first screen whether to stay, and it showed one GIF and a generic sentence. It now says what you can learn, links to the book and all simulations, and shows six demos in a grid, starting with the EKF/UKF/PF comparison that makes the project different, each linked to its chapter. The social preview image (1280x640) is drawn from the same demos by doc/social_preview.py when the book is built, published at the book's root, and used as the book's link preview image. It is not committed, like the book's figures. The CI badges pointed to the old repository name, the pyright setup was for contributors and moves to HOWTOCONTRIBUTE.md, and the book section no longer describes a personal plan. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
GitHub only displays an animated GIF in a README when it can wrap the image in its own link; inside our link to the book the six demos stayed blank. The link to the chapter moves to the caption under each demo. 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.
Closes #88 except the endorsements, which need the quoted people's permission first (see the comment on #88).
Change
README, first screen
AutonomousDrivingSamplePrograms, and a badge for the book is added.README, other sections
sys.pathsection moves toHOWTOCONTRIBUTE.md(Step 2), since it is for contributors.Social preview image
doc/social_preview.pydraws a 1280×640 image (about 180 KB) with the title and a frame of each of the six demos. The white margins are cropped.config-inited(before Sphinx checkshtml_extra_path). The image is published at https://shisatoyano.github.io/AutonomousVehicleControlBeginnersGuide/social_preview.png and is not committed (doc/_extra/is ignored), like the figures.og:imageuses it instead of the NDT GIF.Check
-Wwithout warnings, and the image is in the build output.test_book_chapters.pypasses.After merge (maintainer)
Download https://shisatoyano.github.io/AutonomousVehicleControlBeginnersGuide/social_preview.png and upload it in Settings → General → Social preview (there is no API for it).
🤖 Generated with Claude Code