Skip to content

Commit 51a783b

Browse files
authored
Merge pull request #5981 from FlowFuse/5980-inline-completions-docs
Update assistant documentation for inline completions feature
2 parents f8d1394 + 093f1d8 commit 51a783b

File tree

1 file changed

+12
-6
lines changed

1 file changed

+12
-6
lines changed

docs/user/assistant.md

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,10 +14,11 @@ plugin that aims to helps you work faster and smarter.
1414
The plugin currently supports 2 features:
1515

1616
1. Function node creation directly from the Node-RED editor toolbar
17-
2. In-line Function code generation within the function node editor
18-
3. In-line JSON generation within the JSON editor
17+
2. In-editor Function code generation within the function node editor
18+
3. In-editor JSON generation within the JSON editor
1919
4. Flow Explainer to explain the selected nodes
20-
5. In-line CSS and HTML generation for FlowFuse Dashboard `ui-template` nodes
20+
5. In-editor CSS and HTML generation for FlowFuse Dashboard `ui-template` nodes
21+
6. Inline code completions for Function node, Tables Query node and FlowFuse Dashboard `ui-template` node
2122

2223
To enable the Assistant and any new features, ensure your instance is running the latest Stack and the assistant is updated to the latest version.
2324

@@ -42,7 +43,7 @@ If your function node requires multiple outputs, the assistant will know to set
4243
on the function node setup.
4344

4445

45-
### In-line Function Code Generation
46+
### Function Code Generation
4647

4748
The FlowFuse Assistant plugin also adds a new code lens to the function node editor that allows you
4849
to generate code directly within the editor.
@@ -52,7 +53,7 @@ to generate code directly within the editor.
5253
This is useful when you want to quickly add code to an
5354
existing function node without having to generate a full function node from scratch.
5455

55-
### In-line JSON Generation
56+
### JSON Generation
5657

5758
The FlowFuse Assistant plugin also adds a code lens to the JSON editor that allows you
5859
to generate JSON directly within the monaco editor.
@@ -66,9 +67,14 @@ any node that the TypedInput offers the JSON editor.
6667
The FlowFuse Assistant plugin also adds a new button to the Assistant menu that will explain what the selected nodes do.
6768
To use this feature, simply select the 1 or more nodes that you want to understand and click the "Explain Flows" button in the Assistant menu.
6869

69-
### In-line CSS and HTML Generation for FlowFuse Dashboard
70+
### CSS and HTML Generation for FlowFuse Dashboard
7071

7172
The FlowFuse Assistant plugin also adds a code lens to the FlowFuse Dashboard `ui-template` node that allows you
7273
to generate CSS and HTML directly within the code editor. It is aware of the context of the node and will
7374
generate suitable CSS and HTML components for vuetify and the FlowFuse Dashboard.
7475

76+
### Inline Code Completions
77+
78+
The FlowFuse Assistant plugin also provides inline code completions for Function nodes, Tables Query nodes, and FlowFuse Dashboard `ui-template` nodes.
79+
This feature helps you quickly complete your code without having to leave the editor.
80+
It is context-aware and can suggest completions based on the current cursor position and the surrounding code.

0 commit comments

Comments
 (0)