Skip to content

docs: sync README and CLAUDE.md with current feature set - #8

Merged
jjsnack merged 2 commits into
mainfrom
docs/readme-claude-sync
Jul 28, 2026
Merged

docs: sync README and CLAUDE.md with current feature set#8
jjsnack merged 2 commits into
mainfrom
docs/readme-claude-sync

Conversation

@jjsnack

@jjsnack jjsnack commented Jul 28, 2026

Copy link
Copy Markdown
Owner

Summary

  • README: adds Shortcodes table, Console section (theme/music commands, colour themes), updates Images section (no border, click-to-zoom), fixes stale "Hugo ≥0.116" claim (repo/package cards use try, added in 0.141).
  • hello-world.md: trims the kitchen-sink shortcode demo back to a plain prose/typography post now that shortcodes.md (docs: shortcode reference post #7) is the real reference, with a pointer to it.
  • CLAUDE.md: new Shortcodes section — positional/named param mixing gotcha (bit us twice), shared .repo-card component, try-based build-time fetch pattern, fail-soft-vs-fail-loud convention, why mailto is the one shortcode that ships JS. Fixes the same stale "no JS"/"Hugo 0.116" claims.

These two commits were originally queued behind #7 but that PR got merged before they landed, so they're split out here.

Test plan

  • pnpm build clean

🤖 Generated with Claude Code

https://claude.ai/code/session_01K5qPo8jfbbrvWKrWQyZ8iK

jjsnack and others added 2 commits July 28, 2026 16:12
README was missing shortcodes, the console (theme/music commands), and
colour themes entirely, and still listed Hugo 0.116 as the minimum even
though the repo/package cards now use the try keyword (0.141+). Add
sections for all of it and bump the version note.

hello-world had grown into a shortcode kitchen sink once shortcodes.md
existed as the real reference — trimmed back to its original job (prose
and typography demo), with a pointer to the new reference post.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K5qPo8jfbbrvWKrWQyZ8iK
Add a Shortcodes section covering the positional/named param gotcha
(bit us twice), the shared .repo-card component, the try-based build-time
fetch pattern, the fail-soft-vs-fail-loud split, and why mailto is the one
shortcode that ships JS. Also fixes the stale "no JS dependencies" and
"Hugo 0.116" claims, both now inaccurate.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01K5qPo8jfbbrvWKrWQyZ8iK
@jjsnack
jjsnack merged commit 4dfff3a into main Jul 28, 2026
1 check passed
@jjsnack
jjsnack deleted the docs/readme-claude-sync branch July 28, 2026 06:14
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant