docs: add plugin-stack-persistence README (FEP-2672)

[ENvironmentSet]

Linear: FEP-2672

[changeset-bot]

⚠️ No Changeset found

Latest commit: fef2fde

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: f13ab373-a2d4-4f37-b200-50cdd13dea7d

📥 Commits

Reviewing files that changed from the base of the PR and between 2b66188 and fef2fde.

📒 Files selected for processing (1)

• extensions/plugin-stack-persistence/README.md

Disabled knowledge base sources:

• Jira integration is disabled
• Linear integration is disabled

You can enable these sources in your CodeRabbit configuration.

---

📝 Walkthrough

Summary by CodeRabbit

• Documentation
  • Added comprehensive documentation for stack persistence.
  • Covered installation, setup, loading and saving behavior, metadata validation, snapshot restoration, expiration, error handling, and storage requirements.
  • Added examples for local storage, version validation, strategy composition, and TypeScript APIs.

Walkthrough

This PR adds a README file for the @stackflow/plugin-stack-persistence package. It documents installation steps, storage and strategy contracts, snapshot restoration behavior, error handling, and public API and type signatures with usage examples.

Changes

Documentation

Layer / File(s)	Summary
Persistence plugin README extensions/plugin-stack-persistence/README.md	New README documents installation, plugin setup, synchronous loading, asynchronous saving, metadata validation, reuse policies, snapshot restoration, error handling, storage requirements, public APIs (stackPersistencePlugin, composeStrategies), and type definitions (StackSnapshotStorage, StackSnapshotRecord, StackSnapshotMetadataDefinition, StackSnapshotStrategy, Result).

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

• daangn/stackflow#723: Documents the StackSnapshot and persistence plugin contracts introduced in this PR.
• daangn/stackflow#727: Documents the storage, strategy, and error types implemented in the stack-persistence plugin.
• daangn/stackflow#734: Documents the composeStrategies API signature and related types.

✨ Finishing Touches 💡 1

🛠️ Fix failing CI checks 💡

• Create stacked PR
• Commit on current branch

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch docs/plugin-stack-persistence-readme

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[pkg-pr-new]

• @stackflow/demo

  yarn add https://pkg.pr.new/@stackflow/plugin-stack-persistence@747.tgz
  

commit: a880433

[cloudflare-workers-and-pages]

Deploying stackflow-demo with    Cloudflare Pages

Latest commit:	fef2fde
Status:	⚡️  Build in progress...

View logs