docs: add docs for verify_new_address and notify_previous_addresses#2597
Open
jonas-jonas wants to merge 1 commit into
Open
docs: add docs for verify_new_address and notify_previous_addresses#2597jonas-jonas wants to merge 1 commit into
jonas-jonas wants to merge 1 commit into
Conversation
jonas-jonas
requested review from
aeneasr,
piotrmsc,
unatasha8,
vinckr,
wassimoo and
zepatrik
as code owners
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: ⛔ Files ignored due to path filters (4)
📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThis PR updates the Docusaurus network sidebar configuration to register two new Ory Actions documentation pages— ChangesOry Actions Sidebar Documentation
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~2 minutes Possibly related PRs
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
There was a problem hiding this comment.
Pull request overview
Adds documentation for two additional Ory Actions (verify_new_address and notify_previous_addresses) and wires them into the Network docs navigation and the Kratos “configure hooks” overview so users can discover and configure them.
Changes:
- Added two new action docs: Verify address changes and Notify previous addresses.
- Updated the “Configure hooks” page to include the new actions and adjust the actions count/table.
- Added the new docs to the Network sidebar and cross-linked from the existing address-verification docs.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
sidebars-network.ts |
Adds the new action docs to the “Ory Actions” section for discoverability. |
docs/kratos/hooks/01_configure-hooks.mdx |
Updates the available actions list/count and links to the new action docs. |
docs/actions/verify-new-address.mdx |
New documentation page describing verify_new_address behavior and configuration. |
docs/actions/require-verified-address.mdx |
Cross-links readers to verify_new_address for “verify before applying change” behavior. |
docs/actions/notify-previous-addresses.mdx |
New documentation page describing notify_previous_addresses, including recipients configuration. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+108
to
+110
| | [`verify_new_address`](../../actions/verify-new-address.mdx) | Defers an address change until the user verifies the new address. | For use only with the `after` settings flow, `profile` method only. | | ||
| | [`notify_previous_addresses`](../../actions/notify-previous-addresses.mdx) | Notifies the user's previous addresses when they change a verifiable address. | For use only with the `after` settings flow, `profile` method only. Accepts a `recipients` configuration. | | ||
| | [`web_hook`](../../guides/integrate-with-ory-cloud-through-webhooks.mdx) | Allows to trigger external and custom logic. Can be used with all flows and methods except error and logout. | Requires providing webhook configuration. It is the most common action type for the `after` settings flow. See an example of using webhooks [here](../../guides/integrate-with-ory-cloud-through-webhooks.mdx). | |
Comment on lines
+114
to
+116
| The `verify_new_address` action defers the change until the new address is verified. This differs from the `show_verification_ui` | ||
| action described in [Verification on address change](require-verified-address.mdx#verification-on-address-change), which applies | ||
| the change immediately and only redirects the user to the verification screen afterwards. |
Comment on lines
+11
to
+13
| The `notify_previous_addresses` action sends a notification to a user's previous email or phone addresses when they change a | ||
| verifiable address through the settings flow. Use it to alert users to address changes on their account so they can react if a | ||
| change was not made by them. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Related Issue or Design Document
Checklist
If this pull request addresses a security vulnerability,
I confirm that I got approval (please contact security@ory.com) from the maintainers to push the changes.
Further comments
Summary by CodeRabbit