Skip to content

docs(readme): clarify what adding a dialect actually involves - #16

Merged
andrebaaij merged 1 commit into
mainfrom
docs/readme-adding-a-dialect
Aug 10, 2026
Merged

andrebaaij merged 1 commit into
mainfrom
docs/readme-adding-a-dialect

Conversation

@andrebaaij

Copy link
Copy Markdown
Contributor

Why

The README's "adding a dialect" paragraph described a single Dialect interface with Parse/Emit methods. That hasn't matched the code for a while — dialect/dialect.go splits the work into Parser (dialect files → IR) and Emitter (IR → dialect files), each embedding a minimal Dialect that only carries Name().

What

  • Name Parser and Emitter explicitly instead of the stale single-interface description.
  • Link to dialect/dialect.go so the interfaces are one click away.
  • Mention init() registration.
  • Call out that a target-only dialect is a single method, Emit — the cheapest useful contribution.
  • Link to CONTRIBUTING.md for the full walkthrough.

Docs only; no code changes.

🤖 Generated with Claude Code

The 'adding a dialect' paragraph described a single `Dialect` interface
with `Parse`/`Emit` methods, which no longer matches the code:
dialect/dialect.go splits it into `Parser` (dialect files to IR) and
`Emitter` (IR to dialect files), both embedding a minimal `Dialect`.

Name the two interfaces, link to dialect/dialect.go and the CONTRIBUTING
section, and note that a target-only dialect needs just `Emit`.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@andrebaaij
andrebaaij merged commit 9155e78 into main Aug 10, 2026
1 check passed
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