Skip to content

Commit

Permalink
Merge pull request #4102 from FlowFuse/4101-nr-assistant-user-docs
Browse files Browse the repository at this point in the history
User documentation update for FlowFuse Assistant
  • Loading branch information
knolleary authored Jul 4, 2024
2 parents 33899f3 + b60f456 commit 76812fb
Show file tree
Hide file tree
Showing 5 changed files with 53 additions and 0 deletions.
51 changes: 51 additions & 0 deletions docs/user/assistant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
---
navTitle: FlowFuse Assistant
---

# FlowFuse Assistant Plugin

**Introduced in FlowFuse 2.6 on FlowFuse Cloud only. This feature is not yet available for self-hosted customers.**

The FlowFuse Assistant brings the power of AI to the Node-RED editor.

Node-RED instances running within FlowFuse Cloud will include the **FlowFuse Assistant**
plugin that aims to helps you work faster and smarter.

The plugin currently supports 2 features:

1. Function node creation directly from the Node-RED editor toolbar
2. In-line Function code generation within the function node editor

To enable the Assistant, ensure your Instance is running the latest Stack.



### Function Node Creation

The FlowFuse Assistant plugin adds a new button to the Node-RED editor toolbar that allows you to
ask for a new function node to be created.

![toolbar](./images/assistant/toolbar.png)

![assistant dialog](./images/assistant/dialog-function-node-builder.png)

This is useful when you want to quickly add a function
node to your flow without having to drag it from the palette and write the code yourself.

If your instance supports external modules, you can also ask for a function node that uses this
and it will be added to the function node setup.

If your function node requires multiple outputs, the assistant will know to set the number of outputs
on the function node setup.


### In-line Function Code Generation

The FlowFuse Assistant plugin also adds a new code lens to the function node editor that allows you
to generate code directly within the editor.

![inline code lens](./images/assistant/function-node-inline-code-lens.png)

This is useful when you want to quickly add code to an
existing function node without having to generate a full function node from scratch.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/user/images/assistant/toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions docs/user/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,5 @@ FlowFuse supports reading and writing persistent files and persistent context.
- [Shared Team Library](/docs/user/shared-library.md) - Share flows easily between different Node-RED instances in your team.
- [Node-RED Tools Plugin](/docs/migration/node-red-tools.md) - A plugin for Node-RED that lets you work with your flows outside of FlowFuse.
- [High Availability mode](/docs/user/high-availability.md) - Run multiple copies of your instance for scaling and availability.
- [FlowFuse Assistant](/docs/user/assistant.md) - A plugin for Node-RED that helps you code faster.

0 comments on commit 76812fb

Please sign in to comment.