Skip to content

Rewrite CLAUDE.md with improved structure and detail#1125

Merged
threeal merged 1 commit into
mainfrom
improve-claude-md
Jun 3, 2026
Merged

Rewrite CLAUDE.md with improved structure and detail#1125
threeal merged 1 commit into
mainfrom
improve-claude-md

Conversation

@threeal
Copy link
Copy Markdown
Owner

@threeal threeal commented Jun 3, 2026

Summary

  • Replaces the flat ## Commands dump with dedicated sections per workflow: Running TypeScript, Testing, Checking and Fixing, Building and Packaging, and CI — each with the relevant commands and surrounding context
  • Splits ## Architecture into subsections: Source Files, TypeScript Configuration, and Build Outputs — and adds full detail on both tsconfig files, the .js extension requirement, and the bin shorthand in package.json
  • Expands ## Tooling to cover pnpm, Dependabot, and jiti (previously missing), and trims the Lefthook entry to its essential facts
  • Moves the "TypeScript targeting Node 24 (ESM)" description from Architecture into the About section where it belongs; removes the duplicate line in Architecture
  • Updates the template notice to address Claude Code directly rather than a generic end-user
  • Fixes the bin entry to note it uses shorthand notation (name derived from package name)

🤖 Generated with Claude Code

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Signed-off-by: Alfi Maulana <alfi.maulana.f@gmail.com>
@threeal threeal self-assigned this Jun 3, 2026
@threeal threeal added this to the Version 4.1.0 milestone Jun 3, 2026
@threeal threeal added the documentation Improvements or additions to documentation label Jun 3, 2026
@threeal threeal added this to Granary Jun 3, 2026
@threeal threeal moved this to Harvestable in Granary Jun 3, 2026
@threeal threeal merged commit 6677d27 into main Jun 3, 2026
1 check passed
@threeal threeal deleted the improve-claude-md branch June 3, 2026 04:02
@github-project-automation github-project-automation Bot moved this from Harvestable to Harvested in Granary Jun 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

Status: Harvested

Development

Successfully merging this pull request may close these issues.

1 participant