Skip to content

Conversation

d-gubert
Copy link
Member

docs: Document slash command lifecycle in apps-engine

Proposed changes (including videos or screenshots)

This PR introduces a new markdown file (slash-command-lifecycle-flowchart.md) that documents the lifecycle of slash commands within the Rocket.Chat Apps Engine.

The file includes:

  • A detailed Mermaid flowchart illustrating the state transitions of slash commands from app installation to removal.
  • Answers to key questions regarding when slash commands become visible to users and which AppActivationBridge notifications are triggered during their lifecycle.
  • Explanations of command states (isRegistered, isEnabled, isDisabled) and ownership rules.

This documentation aims to provide a clear understanding of how slash commands are managed and interact with the app lifecycle.

Issue(s)

N/A

Steps to test or reproduce

Review the slash-command-lifecycle-flowchart.md file to ensure clarity and accuracy of the documented lifecycle.

Further comments

This documentation helps clarify the often complex process of slash command registration, enabling, disabling, and unregistration, which is tightly coupled with the app's lifecycle. It should be a valuable resource for app developers and maintainers.


Open in Cursor Open in Web

Copy link
Contributor

cursor bot commented Aug 28, 2025

Cursor Agent can help with this pull request. Just @cursor in comments and I'll start working on changes in this branch.
Learn more about Cursor Agents

Copy link
Contributor

dionisio-bot bot commented Aug 28, 2025

Looks like this PR is not ready to merge, because of the following issues:

  • This PR is missing the 'stat: QA assured' label
  • This PR is missing the required milestone or project
  • This PR has an invalid title

Please fix the issues and try again

If you have any trouble, please check the PR guidelines

Copy link

changeset-bot bot commented Aug 28, 2025

⚠️ No Changeset found

Latest commit: c5f27a7

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

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copy link

codecov bot commented Aug 28, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 65.11%. Comparing base (3825afa) to head (c5f27a7).

Additional details and impacted files

Impacted file tree graph

@@             Coverage Diff             @@
##           develop   #36826      +/-   ##
===========================================
- Coverage    66.13%   65.11%   -1.03%     
===========================================
  Files         3303     3114     -189     
  Lines       110998   108077    -2921     
  Branches     21051    20369     -682     
===========================================
- Hits         73411    70371    -3040     
- Misses       34912    35278     +366     
+ Partials      2675     2428     -247     
Flag Coverage Δ
e2e 54.17% <ø> (-3.10%) ⬇️
unit 71.50% <ø> (+<0.01%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

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

Successfully merging this pull request may close these issues.

4 participants