docs(README): use absolute GitHub URLs for hero logo#177
Merged
Conversation
The .github/ directory is not in package.json `files`, so npm-published READMEs render the hero <picture> as broken images. Switch the three sources (English + Chinese) to raw.githubusercontent.com on main so the npm documentation matches the GitHub experience without bloating the shipped tarball with brand assets. The previous PR (#176) landed the brand assets on main, so these absolute URLs now resolve. Verified raw URL returns 200.
Replace the `---` horizontal rule between the language switcher and the intro paragraph with a `<br />` — same visual gap, no heavy line on top of the `<h1>` underline GitHub auto-renders. Add `<br />` before the logo and between the logo and `<h1>` so the hero block isn't crammed against the top edge or the title.
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.
Summary
Replace the relative
.github/brand/logo-mark-*.svgpaths in the hero<picture>(English + 中文) with absoluteraw.githubusercontent.com/.../main/...URLs.Why
package.jsonfilesships only["dist", "docs", "README.md", "LICENSE"]—.github/is not in the npm tarball, so the npm-published README renders the hero logo as broken images. Switching to absolute URLs onmainfixes npm without bloating the published package.Test plan
curl -I https://raw.githubusercontent.com/JackChen-me/open-multi-agent/main/.github/brand/logo-mark-light.svg→ 200 (assets landed on main via docs(README): refresh positioning, branding, and section layout #176)<source>and<img>srcset/src fields