Repository navigation
Logo, social card, SEO metadata and a detailed README - #6
Merged
Merged
Conversation
- A logo (chip with five pipeline stages), a 32px favicon, and a 1200x630 social card. web/scripts/make_logo.py writes the SVGs; render_social.sh renders the card to PNG with the Chromium the browser tests use. - Open Graph and Twitter card tags, canonical links, theme colour, author and robots meta on every page; schema.org SoftwareSourceCode JSON-LD on the home page. - A web manifest, a sitemap endpoint and a robots line that points to it. - A browser test that fails if the social tags, structured data or sitemap go missing. - A README rewritten around the project's facts: what it is, features and their limits, how it works (diagram), architecture, measured performance, the verification table, FPGA results, quick start, layout, the Tiny series and an FAQ. - Repository description, homepage and topics.
# Conflicts: # README.md
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.
Adds the project's identity and discoverability:
web/public/logo.svg,favicon.svg), generated byweb/scripts/make_logo.py.og-image.png(1200x630), used by Open Graph and Twitter cards.SoftwareSourceCodedata on the home page, a web manifest, a sitemap, and a robots line that points to it. A browser test guards these.Repository description, homepage and topics are set on the repo.
Checks run locally: web lint, typecheck, 74 unit tests, the production build, and 18 browser tests including the new metadata check. The README's relative links all resolve.