Fix broken links/badges, typos, and sync README_zh with English#21
Merged
Conversation
- README_zh: point Lint badge at the real workflow (lint.yml, not action.yml) - README: fix docToolchain link/badge (doctoolchainb -> doctoolchain) - README/README_zh: drop .git suffix from Beautiful Docs URL/badge - README: strip query/fragment from Petstore Kafka star badge - README: fix typos (Lean->Learn, Cconverts->Converts, "A a"->"A") - CONTRIBUTING: fix malformed pre-commit link and grammar - add_stars.py: strip .git/?query/#fragment from repo name before building badges; remove leftover scratch comments Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016vt1NUzDAEMZX3KL2UoaZd
- Add NRG (README section) and Sourcey (Site Builder) to match README.md - Run hardened add_stars.py over README_zh.md to add GitHub star badges across all sections (previously only present in Site Builder), reaching parity with README.md (118 badges each) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_016vt1NUzDAEMZX3KL2UoaZd
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
2 participants
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.
Overview
A whole-repository quality pass: fixes reader-visible broken links/badges and typos, hardens the badge-generation script, and brings
README_zh.mdto parity withREADME.md.Fixes (commit 1)
Broken links / badges
README_zh.md: Lint badge pointed at a non-existent workflow (action.yml) → nowlint.yml(+?branch=main)README.md: docToolchain link/badgedoctoolchainb→doctoolchain(was a double 404)README.md/README_zh.md: drop.gitsuffix from Beautiful Docs URL/badge (badge was 404)README.md: strip?query/#fragmentfrom the Petstore Kafka star badgeCONTRIBUTING.md: fix malformed pre-commit link (missing)) and grammarTypos
Lean→Learn(×2),Cconverts→Converts,A a/A a→AScript hardening —
scripts/add_stars.py.gitand any?query/#fragmentfrom the repo name before building badges (the root cause of the broken badges above)README_zh sync (commit 2)
README.mdadd_stars.pyoverREADME_zh.mdto add star badges across all sections (previously only in Site Builder), reaching parity withREADME.md(118 badges each)Verification
add_stars.pyis idempotent on already-badged content ("No changes needed").git/?/#) or duplicated badges in the resultpetstore-kafka?...,beautiful-docs.git) produce clean badgesNot included (low impact, can follow up)
reStructuredTextentry under Sphinx🤖 Generated with Claude Code
https://claude.ai/code/session_016vt1NUzDAEMZX3KL2UoaZd
Generated by Claude Code