Skip to content

Conversation

@ncipollina
Copy link
Contributor

🚀 Pull Request

📋 Summary

Updates project documentation to reflect the newly implemented collection mapping support feature. This includes comprehensive updates to the README, API reference, usage guides, and examples to document how to work with Lists, Maps, and Sets in DynamoDB mappings.


✅ Checklist

  • My changes build cleanly
  • I've added/updated relevant tests
  • I've added/updated documentation or README
  • I've followed the coding style for this project
  • I've tested the changes locally (if applicable)

🧪 Related Issues or PRs

Related to #47 - Collection mapping support implementation


💬 Notes for Reviewers

Documentation updates cover:

  • README.md with collection mapping examples
  • API reference for collection-related attributes and runtime helpers
  • Usage guides for converters and customization
  • Quick start guide updates
  • Single-table design pattern examples with collections

All documentation has been updated to align with the collection mapping functionality implemented in the codebase.

Updated documentation across multiple sections to reflect the new
collection mapping functionality, including usage examples and API
reference updates.

Co-Authored-By: Claude Sonnet 4.5 <[email protected]>
@ncipollina ncipollina requested a review from j-d-ha January 16, 2026 21:35
Copy link
Collaborator

@j-d-ha j-d-ha left a comment

Choose a reason for hiding this comment

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

👍 LGTM. This is huge. Left 2 comments.

Comment on lines +15 to +16
DateTimeFormat = "O",
EnumFormat = "G")]
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe add guid and timespan formats here to if you want all props set?

| `bool` | BOOL | |
| `Guid` | S | ToString/Parse |
| `DateTime`, `DateTimeOffset` | S | ISO-8601 |
| `DateTime`, `DateTimeOffset`, `TimeSpan` | S | ISO-8601 / constant format |
Copy link
Collaborator

Choose a reason for hiding this comment

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

I think timespan needs to be added

@ncipollina ncipollina merged commit 396a5ec into main Jan 17, 2026
2 checks passed
@ncipollina ncipollina deleted the docs/update-collection-mapping branch January 17, 2026 00:09
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.

3 participants