Skip to content

Update documentation for stacked dialogs#1514

Open
sbishel wants to merge 5 commits into
masterfrom
interactive-dialog-stacked
Open

Update documentation for stacked dialogs#1514
sbishel wants to merge 5 commits into
masterfrom
interactive-dialog-stacked

Conversation

@sbishel

@sbishel sbishel commented Jun 29, 2026

Copy link
Copy Markdown
Member

Summary

Changes:
This PR adds comprehensive documentation for the new stacked dialogs feature (Mattermost v11.10+) to the interactive dialogs plugin guide.

What's new:

  • Stacked dialogs overview: Introduced at the top of the doc explaining that dialogs can now be nested up to 3 levels deep
  • New action_button element type: Full documentation for the button that opens child dialogs without submitting the parent
    • Includes JSON schema with display_name, name, type, and action_button config
    • Documents the url and optional context fields for button configuration
  • Action button flow: Detailed explanation of how the feature works:
    • What happens when a user clicks the button
    • The PostActionIntegrationRequest payload structure
    • How integrations open child dialogs using the returned trigger_id
  • Limits & warnings: Clear note that up to 3 dialogs can be stacked; beyond that is silently ignored
  • Breaking change note: Documents the v11.10 behavior change where team_id is now server-derived from the channel rather than client-supplied (affecting /submit, /lookup, and /execute endpoints)

Related

Product PR:

Ticket Link

Fixes: https://mattermost.atlassian.net/browse/MM-69219

@github-actions

Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 4c0f26e

@coderabbitai

coderabbitai Bot commented Jun 29, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 77217a0e-7a0e-4301-bc9d-fd338f786698

📥 Commits

Reviewing files that changed from the base of the PR and between 2bf7bd6 and 8ed4418.

📒 Files selected for processing (1)
  • site/content/integrate/plugins/interactive-dialogs/_index.md

📝 Walkthrough

Walkthrough

Interactive dialog documentation now covers v11.10 stacked dialogs through action_button, including the three-dialog limit and execution flow. It also documents channel-derived team_id values for dialog endpoints, including DM/GM behaviour.

Changes

Interactive Dialogs Documentation

Layer / File(s) Summary
Stacked dialogs and action_button element
site/content/integrate/plugins/interactive-dialogs/_index.md
Documents the v11.10 action_button element, its schema, execute/open flow, new trigger ID, three-dialog limit, and updated file element version.
team_id channel-derived behaviour
site/content/integrate/plugins/interactive-dialogs/_index.md
Updates team_id documentation to state that the server derives it from the dialog channel, ignores client-supplied values, and uses an empty string for DM/GM channels.

Estimated code review effort: 2 (Simple) | ~10 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly matches the main change: documentation updates for stacked dialogs.
Description check ✅ Passed The description accurately summarizes the documentation changes for stacked dialogs and the team_id behaviour change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch interactive-dialog-stacked

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

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

@coderabbitai coderabbitai Bot left a comment

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.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@site/content/integrate/plugins/interactive-dialogs/_index.md`:
- Line 628: The heading under the `### Action button elements` section skips a
level and breaks the document hierarchy. Update the `Minimum Server Version:
11.10` heading in the interactive dialogs content to use the next proper heading
level, keeping the section structure consistent with markdownlint MD001.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6ac9addc-edbb-4064-9b11-5ebf571c903c

📥 Commits

Reviewing files that changed from the base of the PR and between dca0a0a and 4c0f26e.

📒 Files selected for processing (1)
  • site/content/integrate/plugins/interactive-dialogs/_index.md

Comment thread site/content/integrate/plugins/interactive-dialogs/_index.md
@github-actions

Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA d647d75

@github-actions

Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 8a703d4

@github-actions

Copy link
Copy Markdown

Newest code from mattermost has been published to preview environment for Git SHA 8ed4418

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.

1 participant