Skip to content

v1.1.0 — cross-link repair, LICENSE, and CI

Latest
Latest

Choose a tag to compare

View all tags
@anneheartrecord anneheartrecord released this 11 Aug 02:21
· 1 commit to main since this release
v1.1.0
d3844a4
This commit was created on GitHub.com and signed with GitHub’s verified signature.
GPG key ID: B5690EEEBB952194
Verified
Learn about vigilant mode.

First maintenance release since the initial publication. No chapter conclusions changed; this fixes defects and puts the repo on a footing where the next content update can be verified automatically.

Fixed

  • All 56 chapter cross-links 404'd in GitHub's file view. They were written as docs/<file>.md from inside docs/, which worked on the docsify site but resolved to docs/docs/<file>.md on GitHub — the view anyone browsing or forking the repo actually lands on. Links are now same-directory relative and correct in both contexts.
  • One link was dead everywhere: chapter 12 pointed at chapter 13 under a filename that stopped existing when it was renamed.
  • English chapter 01 was a third the size of the Chinese one (5.2 KB vs 15 KB), missing the source-leak background, what Claude Code is, how it differs from an agent framework, the six-step request journey, the industry comparison, and the key-numbers table. Now at parity, translated from the existing Chinese analysis.
  • The two READMEs had drifted apart.

Added

  • LICENSE — MIT, declared in the READMEs since day one but never committed, so GitHub reported the repo as unlicensed.
  • scripts/check_links.py and scripts/check_bilingual.py, run by GitHub Actions on every push, every PR, and weekly.
  • CONTRIBUTING.md / CONTRIBUTING_EN.md, CODE_OF_CONDUCT.md, issue templates for chapter corrections and version drift, and a PR template.
  • Version coverage tables in both READMEs stating which source snapshot the analysis was verified against.
  • CHANGELOG.md.

For readers

If an upstream change has invalidated something a chapter says, the version drift issue template is the fastest way to report it. Corrections with evidence are the most welcome contribution here.

Full changelog: https://github.com/anneheartrecord/claude-code-docs/blob/main/CHANGELOG.md

Assets 2
Loading