Skip to content

[PersistableState] Improve documentation for how to use persistable state services #103105

@stacey-gammon

Description

@stacey-gammon

This issue covers two things.

  1. A new tutorial should be added to the developer guide to cover both how to persist persistable state in a saved object (very important to call inject/extract/migration functions), as well as how to implement persistable state (call out how important it is to write a migration function any time you change the shape of your data).
  2. The in-code comments on the persistable state service could be improved or should direct the user to the tutorial for more information.

Metadata

Metadata

Assignees

No one assigned

    Labels

    impact:mediumAddressing this issue will have a medium level of impact on the quality/strength of our product.loe:mediumMedium Level of Effortneeds_docs

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions