Skip to content

feat: add self-service account deletion docs#1354

Open
cjbell wants to merge 1 commit intomainfrom
cb-self-service-account-deletion
Open

feat: add self-service account deletion docs#1354
cjbell wants to merge 1 commit intomainfrom
cb-self-service-account-deletion

Conversation

@cjbell
Copy link
Contributor

@cjbell cjbell commented Mar 18, 2026

Description

New lightweight docs page for self-service account deletion.

@vercel
Copy link

vercel bot commented Mar 18, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Mar 18, 2026 1:25am

Request Review

Copy link

@cursor cursor bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Risk MEDIUM: Adds a new documentation page for self-service account deletion with a sidebar navigation update and a minor permissions table change.

Reasons

  • A new MDX file (content/manage-your-account/account-deletion.mdx) is added, which triggers MEDIUM risk per new-page rules.
  • The sidebar navigation file (data/sidebars/platformSidebar.ts) is modified to include the new page entry.
  • No component, layout, library, or style files are touched, so HIGH risk triggers do not apply.
  • The diff is small (49 additions, 0 deletions across 3 files) and limited to a single documentation section (manage-your-account).
  • No package, build config, or OpenAPI spec changes are present.

Notes

  • Verify the new page renders correctly at /manage-your-account/account-deletion and the sidebar entry appears in the expected position.
  • Confirm internal links (/manage-your-account/managing-members, /manage-your-account/data-retention) resolve correctly and do not 404.
  • Check that the Callout component usage matches the expected pattern used elsewhere in the docs.
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

Copy link
Contributor

@scotidodson scotidodson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left a couple questions and one style suggestion for the callout

Comment on lines +45 to +46
title="Note"
text="Account deletion is permanent and cannot be undone. Make sure you have exported or migrated any data you need before proceeding."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title="Note"
text="Account deletion is permanent and cannot be undone. Make sure you have exported or migrated any data you need before proceeding."
title="Account deletion is permanent and cannot be undone."
text="Make sure you have exported or migrated any data you need before proceeding."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if it's better to have this right above the How to header? I don't have a strong opinion on that, but might be more noticeable there?

- **API keys.** All API keys will be revoked immediately. Any applications or services using these keys will lose access to Knock.
- **Account members.** All [account members](/manage-your-account/managing-members) will lose access. They will receive an email informing them that the account has been deleted.
- **Integrations.** Any active channel integrations (email, push, chat, SMS) will stop working.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth adding historical records / message logs here? I know it's addressed in the section below, so might be overkill.


1. Open your account settings in the Knock dashboard.
2. Navigate to the **General** section.
3. Find the **Delete account** option and follow the prompts to confirm.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm assuming this is correct -- I couldn't find your control changes. Do you have them staging somewhere?

Comment on lines +45 to +46
title="Note"
text="Account deletion is permanent and cannot be undone. Make sure you have exported or migrated any data you need before proceeding."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
title="Note"
text="Account deletion is permanent and cannot be undone. Make sure you have exported or migrated any data you need before proceeding."
title="Account deletion is permanent and cannot be undone."
text="Make sure you have exported or migrated any data you need before proceeding."

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if this would be more noticeable above the How to header? I'm not sure.

- **Production workflows.** Deactivate or migrate any production workflows that are still sending notifications. Deleting your account will immediately stop all notification delivery.
- **API keys.** All API keys will be revoked immediately. Any applications or services using these keys will lose access to Knock.
- **Account members.** All [account members](/manage-your-account/managing-members) will lose access. They will receive an email informing them that the account has been deleted.
- **Integrations.** Any active channel integrations (email, push, chat, SMS) will stop working.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it worth adding a note about historical records / logs here? I know we cover that in the section below, so might be overkill.


For context on how Knock handles data during normal operation, see [data retention](/manage-your-account/data-retention).

## What happens to account members
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noting that this wraps in the TOC. We could update this and then one above to Data deletion and Account member deletion? Couldn't think of any other good options.

2. Navigate to the **General** section.
3. Find the **Delete account** option and follow the prompts to confirm.
4. Enter your account slug to confirm the deletion.
5. Confirm the deletion. Your account and all associated data will be permanently removed after 24 hours.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are we going to show a confirmation modal/message? Wondering what "confirm the deletion" looks like. If there are any errors/issues, will we display a toast message informing them of the error and that the deletion wasn't successful?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants