docs: add brand logo to README and docs sidebar#388
Merged
Conversation
Use the crescent-moon mark from the website nav bar as the project logo. Adds a self-contained priv/logo.svg (hardcoded purple gradient matching the site favicon), centers it in the README header above the MDOC marker, and sets it as the ExDoc `:logo` for the docs sidebar. Also removes website/priv/static/images/logo.svg, the leftover Phoenix scaffold default (orange flame-bird) that was never referenced.
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
1 participant
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.
What
Uses the crescent-moon mark from the website nav bar (
<.lua_mark>) as the project logo, in two places:<!-- MDOC !-->marker so it renders on GitHub/hex.pm but doesn't leak into the HexDocs module page.logo: "priv/logo.svg"in the docs config.The asset (
priv/logo.svg) is a self-contained version of the nav mark with the brand's hardcoded purple gradient (#a78bfa → #7c3aed, satellite#f0abfc), matchingfavicon.svg. It lives inpriv/because the package ships onlylib/mix.exs/README/LICENSE— docs build from the repo, and GitHub/hex.pm resolve the README's relative path to the repo.Cleanup
Removes
website/priv/static/images/logo.svg— the leftover Phoenix scaffold default (orange flame-bird) that was never referenced anywhere in the site code.Verification
mix docsbuilds clean (no warnings), logo copied todoc/assets/logo.svgand referenced in the sidebar.priv/logo.svgis git-trackable (not caught by thepriv/pltsignore).