docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (#57)#241
Open
Fearvox wants to merge 1 commit into
Open
docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (#57)#241Fearvox wants to merge 1 commit into
Fearvox wants to merge 1 commit into
Conversation
…57) Issue #57 reported two broken entry points: the Discord invite links and the STARTER_KIT.md quick-start links. Both are now resolved. - The README Discord badge is a live, dynamic shields.io badge that queries the Discord invite API (discord.gg/gYep5nQRZJ) directly, so it both renders the online count and self-validates the invite is alive. - STARTER_KIT.md was removed when the project was restructured into methods/ and benchmarks/ (the quick-start moved into the README). This restores a small breadcrumb at docs/STARTER_KIT.md so old links land on the live README Quick Start, EverCore docs, Discord, and contributing guide instead of a 404. All relative links in the breadcrumb were verified to resolve and the README #quick-start anchor exists. Co-authored-by: LeonTung <zhenhangtung@gmail.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.
docs: restore STARTER_KIT breadcrumb to live quick-start and Discord (closes #57)
Issue #57
("STARTER_KIT.md 和 issue 入口 Discord 链接失效") reported two broken entry
points:
STARTER_KIT.mdquick-start links were broken.Both are now resolved in the current tree, and this PR adds the one missing
piece so old
docs/STARTER_KIT.mdlinks no longer 404.Discord link — fixed (and self-validating)
The README Discord badge is a live, dynamic shields.io badge that queries the
Discord invite API directly:
The invite endpoint returns HTTP 200 with a valid invite payload (guild
tag
EVER), so the badge both renders the live online count and doubles as ahealth check that the invite is alive. No dead Discord link remains.
STARTER_KIT.md — restored as a breadcrumb
docs/STARTER_KIT.mdwas removed when the project was restructured intomethods/andbenchmarks/(commit6324c0c), and its quick-start contentmoved into the README's
## Quick Startsection. That fixed the brokenin-file links by deletion, but left old
docs/STARTER_KIT.mdlinks pointingat a 404.
This PR restores a small breadcrumb at
docs/STARTER_KIT.mdthat redirects tothe current canonical destinations:
README.md#quick-startmethods/EverCore/docsdiscord.gg/gYep5nQRZJ.github/CONTRIBUTING.mdVerification (no live stack needed)
grep -n discord.gg/gYep5nQRZJ README.md→ live invite at README.md:8.curl -s -o /dev/null -w "%{http_code}" "https://discord.com/api/v10/invites/gYep5nQRZJ?with_counts=true"→200.docs/(
README.md,methods/EverCore/docs,.github/CONTRIBUTING.md) and theREADME
#quick-startanchor exists (grep "^## Quick Start" README.md).Scope
One file (
docs/STARTER_KIT.md, +21 lines). Pure docs — no code, no runtimebehavior change.
Credit
The original starter-kit quick-start work is by @ZhenhangTung in
#86 ("docs: fix
STARTER_KIT.md's quick start"); this breadcrumb preserves the intent of that
PR after the restructure absorbed its content into the README.
Co-authored-by: LeonTung zhenhangtung@gmail.com
🤖 Generated with Claude Code