docs: fix broken star history chart in README - #416
Open
CrustyMozarella wants to merge 1 commit into
Open
Conversation
The star history chart in the README is broken due to GitHub stargazer API restrictions. Update both the English and Chinese READMEs to use a working alternative so the project's growth stays visible.
Contributor
There was a problem hiding this comment.
Review mode: initial
Findings
- None.
Questions
- Is
star-history.dera.pagethe intended canonical replacement forstar-history.com? This checkout has no reference to the new domain, and the PR does not state who maintains it. If it is a personal/unofficial mirror, the README chart may break again when that mirror goes away, and it sends readers' browsers to an unvetted third party. Please confirm the domain is owned/controlled by a trusted party (for example, the Star History project or this project) before merging.
Summary
- Review mode: initial
- Docs-only PR: swaps the star-history chart URLs in
README.md:298-301andREADME.zh-CN.md:295fromapi.star-history.com/star-history.comtostar-history.dera.page. No source code, dependency, or CI changes; no changeset needed for a README-only fix. - I could not independently verify from the public checkout that the new
/imageand/svgendpoints resolve or render. The existing issue claim about GitHub stargazer API restrictions is plausible but not verifiable from this repo.
Testing
- Not run (automation). README-only change; no unit/E2E tests applicable. Manual check: open the rendered README and confirm both the English
star-history.dera.page/imageand Chinesestar-history.dera.page/svgURLs display a star chart.
Open-CoDesign Bot
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.
The star history chart currently embedded in the README is broken because of GitHub stargazer API restrictions, so the chart no longer renders. This change points the chart (and its wrapping link) in both the English and Chinese READMEs at a working alternative that requires no API token, restoring the stargazer visualization.