Skip to content

docs: document beam-large-records - #826

Merged
LaurentRDC merged 2 commits into
haskell-beam:masterfrom
ColumbusLabs:codex/docs-beam-large-records-825
Jul 27, 2026
Merged

docs: document beam-large-records#826
LaurentRDC merged 2 commits into
haskell-beam:masterfrom
ColumbusLabs:codex/docs-beam-large-records-825

Conversation

@ColumbusLabs

@ColumbusLabs ColumbusLabs commented Jul 26, 2026

Copy link
Copy Markdown
Contributor

Summary

  • document when beam-large-records is useful for schemas with many fields
  • show the plugin, integration import, and largeRecord annotation
  • list the direct dependencies required by the plugin and link authoritative package documentation

Closes #825.

Validation

  • verified the package metadata and example against the official beam-large-records source
  • verified the quoted benchmark values against the upstream timing data and methodology
  • verified all three added links resolve
  • checked Markdown fence balance
  • git diff --check

The repository's nix build .#docs -L check was not available locally because Nix is not installed.

Comment thread docs/user-guide/models.md Outdated

@LaurentRDC LaurentRDC left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@LaurentRDC
LaurentRDC merged commit 77d0bca into haskell-beam:master Jul 27, 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.

Document the existence and purpose of beam-large-records

2 participants