Skip to content

docs(rule-engine): add Create Nested Rule Chain and Forward Messages sections#402

Open
ShvaykaD wants to merge 3 commits into
mainfrom
feature/docs-nested-rule-chain
Open

docs(rule-engine): add Create Nested Rule Chain and Forward Messages sections#402
ShvaykaD wants to merge 3 commits into
mainfrom
feature/docs-nested-rule-chain

Conversation

@ShvaykaD
Copy link
Copy Markdown
Contributor

@ShvaykaD ShvaykaD commented May 21, 2026

Description

Adds two new sub-sections to the Rule Engine user-guide page under Managing Rule Chains:

  • Create a Nested Rule Chain — documents the Ctrl+R / right-click extraction workflow that splits selected nodes from one rule chain into a new sub-chain.
  • Forward Messages to Another Rule Chain — documents adding a Rule Chain flow node so messages from a parent chain are routed into an existing target chain.

Both sub-sections sit between Set a Rule Chain as Root and Delete a Rule Chain, and match the existing sibling-section style (no preamble before <Steps>, link to the Rule Chain flow node reference docs). The Rule Chain node reference page (/docs/reference/rule-engine/nodes/flow/rule-chain/) gets a couple of inbound links.

Motivation: several marketplace rule-chain templates in thingsboard/iot-hub previously inlined the same Ctrl+R + Rule-Chain-node mechanic in their READMEs (~30 lines each), which scaled poorly as more "extend the root chain" templates shipped. The marketplace READMEs now link to these canonical sections instead.

How it looks on the UI

Screenshot from 2026-05-21 16-11-35

Type of change

  • Shared include file (src/content/_includes/**)

Affected products

CE / PE / PaaS — all editions share rule-engine.mdx via _includes.

Related issues

  • Closes #

Checklist

  • `pnpm check` passes (Astro / TypeScript)
  • `pnpm lint:eslint` passes
  • `pnpm lint:slugcheck` passes (required if pages were added/renamed/moved across languages)
  • `pnpm lint:linkcheck` passes locally — required to merge; run it before requesting review
  • Renamed/removed pages have a redirect in `src/data/redirects.ts` — N/A, no pages added/moved
  • No hardcoded versions — values come from `src/data/versions.ts`
  • Screenshots attached for visual changes — N/A, prose-only docs change

…sub-sections

Adds two sub-sections under "## Managing Rule Chains" between
"### Set a Rule Chain as Root" and "### Delete a Rule Chain":

- Create a Nested Rule Chain — Ctrl+R / right-click extraction
  workflow that splits selected nodes from one rule chain into a
  new sub-chain.
- Forward Messages to Another Rule Chain — adding a Rule Chain
  flow node so messages from a parent chain are routed into an
  existing target chain.

Both sub-sections match sibling style (no prose before <Steps>) and
link to the Rule Chain flow node reference. The new anchors are
referenced from marketplace rule-chain readmes in
thingsboard/iot-hub.
selection, **Create nested rule chain** stays disabled.
4. Press **Ctrl+R**, or **right-click** the selection and choose **Create nested rule chain**.
ThingsBoard creates a new rule chain from the selected nodes and replaces them in the
current chain with a single [**Rule Chain**](https://thingsboard.io/docs/reference/rule-engine/nodes/flow/rule-chain/) node pointing at it.
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.

You need to use relative links.
Used auto-generated link:
<DocLink product={props.product} path="reference/rule-engine/nodes/flow/rule-chain/">Rule Chain</DocLink>

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.

2 participants