docs(plugin-activity-guard): add README

[ENvironmentSet]

add a package README for @stackflow/plugin-activity-guard

Linear: FEP-2671

[changeset-bot]

⚠️ No Changeset found

Latest commit: a212473

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: 8e809f63-7d7a-4adf-bba1-2c0f7480f3df

📥 Commits

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

📒 Files selected for processing (1)

• extensions/plugin-activity-guard/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 the activity guard plugin.
  • Covered installation, setup, typed guards, guard composition, redirects, navigation behavior, limitations, plugin ordering, and public APIs.

Walkthrough

The pull request adds README documentation for the activity guard plugin. It covers setup, typed synchronous guards, redirects, composition, navigation behavior, constraints, plugin ordering, and public APIs.

Changes

Activity guard plugin documentation

Layer / File(s)	Summary
Plugin setup and guard usage extensions/plugin-activity-guard/README.md	Defines guard behavior, shows plugin installation, and documents typed sign-in, terms, redirect, and all() examples.
Navigation behavior and public API extensions/plugin-activity-guard/README.md	Documents redirect re-evaluation, navigation constraints, plugin ordering, options, ActivityGuardFor, all(), and redirect().

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

Possibly related PRs

• daangn/stackflow#728: Introduces the activity-guard plugin APIs and behavior documented by this pull request.

✨ 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-activity-guard-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-activity-guard@746.tgz
  

commit: db9d30c

[cloudflare-workers-and-pages]

Deploying stackflow-demo with    Cloudflare Pages

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

View logs