Skip to content

docs(kno-14741): trigger guide step - #1615

Open
emisilvacab wants to merge 6 commits into
mainfrom
emi-kno-14741-docs-trigger-guide-step
Open

docs(kno-14741): trigger guide step#1615
emisilvacab wants to merge 6 commits into
mainfrom
emi-kno-14741-docs-trigger-guide-step

Conversation

@emisilvacab

@emisilvacab emisilvacab commented Aug 19, 2026

Copy link
Copy Markdown
Contributor

Description

Added docs for the trigger guide step, with workflow and broadcast usage, targeting behavior, debugging, and FAQs. Updated the workflow sidebar, guides overview, and broadcasts documentation with links to the new page.

Tasks

KNO-14741

@linear-code

linear-code Bot commented Aug 19, 2026

Copy link
Copy Markdown

KNO-14741

@vercel

vercel Bot commented Aug 19, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Aug 21, 2026 2:03pm

Request Review

@emisilvacab
emisilvacab force-pushed the emi-kno-14741-docs-trigger-guide-step branch from a971cdb to b1d3928 Compare August 19, 2026 18:40

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Risk MEDIUM: Adds new trigger guide step documentation with sidebar navigation and cross-links from related docs.

Reasons

  • Adds a new MDX page at content/designing-workflows/trigger-guide-step.mdx (93 lines)
  • Updates sidebar navigation in data/sidebars/platformSidebar.ts to surface the new page
  • Touches multiple documentation sections: designing-workflows/, concepts/, and in-app-ui/
  • No code, build, dependency, or shared component changes — content and navigation only
  • Diff size (101 additions, 3 deletions across 4 files) is moderate but not a substantial rewrite of existing pages

Notes

  • Verify internal links resolve correctly (/designing-workflows/trigger-guide-step, audience and guide docs)
  • Confirm the new sidebar entry appears in the correct position under "Designing workflows"
  • Review the beta callout and FAQ content for accuracy against the product behavior
  • Check that cross-links from broadcasts.mdx and guides/overview.mdx read naturally in context
Open in Web View Automation 

Sent by Cursor Automation: Docs PR classifier

@cellomatt cellomatt left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Approving to unblock but I left a bunch of nits

Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
separate audience to create or maintain, and no remove action since guide
eligibility from a step is additive only.
</Accordion>
<Accordion title="Can I remove a recipient's eligibility once they're enrolled?">

Copy link
Copy Markdown
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 should be a section in the main page? Or are we thinking most will just archive the guide to remove?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

We don't currently support removing members directly from the managed audience. Once that capability is available, we can add a section explaining how to remove users from the audience and revoke their eligibility in a more straightforward way.

Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/designing-workflows/trigger-guide-step.mdx Outdated
Comment thread content/in-app-ui/guides/overview.mdx Outdated
Comment on lines 84 to 90
the recipient into the guide's targeting the moment the step runs. You can
also use our [update audience
function](/designing-workflows/update-audience-function) to add a user to a
static audience during a workflow run. You can also use the [update user
static audience you manage yourself, or the [update user
function](/designing-workflows/update-user-function) to modify a user's
properties in order to make them eligible for membership in a [dynamic
audience](/concepts/audiences#dynamic-audiences) or for the targeting

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Suggested change
the recipient into the guide's targeting the moment the step runs. You can
also use our [update audience
function](/designing-workflows/update-audience-function) to add a user to a
static audience during a workflow run. You can also use the [update user
static audience you manage yourself, or the [update user
function](/designing-workflows/update-user-function) to modify a user's
properties in order to make them eligible for membership in a [dynamic
audience](/concepts/audiences#dynamic-audiences) or for the targeting
the recipient into the guide's targeting the moment the step runs.
Alternatively, use the [update audience
function](/designing-workflows/update-audience-function) to add a user to a
static audience you manage yourself, or use the [update user
function](/designing-workflows/update-user-function) to modify a user's
properties in order to make them eligible for membership in a [dynamic
audience](/concepts/audiences#dynamic-audiences) or for the targeting

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I wonder if we should be keeping the update user / update audience options? Should we just be directing to the new trigger guide step?

@emisilvacab

Copy link
Copy Markdown
Contributor Author

Changed the name of the step from "Trigger guide" to "In-app guide"

pr https://github.com/knocklabs/control/pull/11105
context https://knocklabs.slack.com/archives/C0BHATK0HC2/p1787229446152079

@emisilvacab

Copy link
Copy Markdown
Contributor Author

Added screenshots:

Screen.Recording.2026-08-21.at.11.08.29.mov

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