Skip to content

Enhance persistence documentation with comprehensive examples and state store guide  #518

@qodo-free-for-open-source-projects

Description

Description

  • Event sourcing documentation lacks practical usage examples, making it difficult for developers to understand how to use the event store API
  • The existing "Aggregate stream" page uses outdated terminology (AggregateId) and focuses on aggregates rather than the underlying state model
  • State loading functionality is undocumented, leaving developers without guidance on using LoadState extension methods
  • Documentation needs to reflect support for both aggregate-based and functional command service patterns

Deliverables

  • Event streams page: Rename and rewrite to be state-centric, document StreamName.For and StreamName.ForState, update identity references to use Id base class
  • Event store examples: Add comprehensive usage examples covering append operations, multi-stream append with atomicity guarantees, reading events, and stream management operations
  • State store page: Create new documentation page explaining LoadState extension methods, FoldedEventStream return type, and how state folding works internally
  • Dual version updates: Apply all changes to both v0.16 stable and next preview documentation versions

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions