docs: align v2 stack documentation (#6564)
This commit is contained in:
1 parent
c92e074a6f
commit
42bf55641b
57 files changed
+487
-175
No files matched your search
@@ -42,9 +42,14 @@ interface HomarrCustomWidgetV2 {
|
||||
|
||||
### Design with AI
|
||||
|
||||
The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and, when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The assistant receives the widget schema, current non-secret configuration, and latest test response, then proposes the matching create or update tool for your approval.
|
||||
The **Design with AI** action is available while creating or editing a custom widget. Describe what the widget should show and,
|
||||
when [Homarr Assistant](../assistant) is enabled, send the request directly from the form. The generated prompt includes the
|
||||
widget schema and current non-secret configuration, but not the latest preview response. It proposes the matching create or
|
||||
update tool for your approval.
|
||||
|
||||
Run **Test** first when possible so the prompt includes the endpoint's real response shape. Saved secrets are never added to the prompt. **Copy to clipboard** remains available when the Assistant is disabled or when you prefer another AI service.
|
||||
Use the preview's **Data** tab to inspect the endpoint's real response shape and mention important fields in your request; the
|
||||
copied prompt does not automatically include the latest preview response. Saved secrets are never added to the prompt. **Copy to
|
||||
clipboard** remains available when the Assistant is disabled or when you prefer another AI service.
|
||||
|
||||
<CustomWidgetCodeExample
|
||||
id="complete-widget-manifest"
|
||||
@@ -62,9 +67,9 @@ preview, publish, install, configure, or write secrets, including through HTTP a
|
||||
only lists Custom Widget MCP tools, prompts, and resources when its owner is an administrator.
|
||||
|
||||
Adding or configuring a Custom Widget placement requires both administrator access and permission to modify that
|
||||
board. A non-administrator with board-modify access can move, resize, change presentation settings, or remove an
|
||||
existing placement, but cannot add one, change its definition, refresh interval, or Custom Widget options. Duplicating
|
||||
a board that contains Custom Widgets also requires an administrator.
|
||||
board. Duplicating a board that contains Custom Widgets also requires an administrator. A non-administrator with
|
||||
board-modify access can move, resize, change presentation settings, or remove an existing placement, but cannot add one,
|
||||
change its definition, refresh interval, or Custom Widget options.
|
||||
|
||||
Once an administrator has placed a widget, ordinary board permissions apply to rendering and requests. Authorized
|
||||
non-administrators can use it on private boards, and queries can render for anonymous viewers on public boards.
|
||||
@@ -99,10 +104,8 @@ logs, or exports.
|
||||
For administrators adding widgets while editing a board, the Custom Widgets section includes **Import from
|
||||
Workshop**. Non-administrators do not see the Custom Widget picker or Workshop actions. Selecting **Install widget**
|
||||
opens a two-step modal flow: first review the Workshop entry and its complete source in the read-only editor, then
|
||||
confirm API sources and credentials. The steps keep the same dimensions and the previous step remains available when
|
||||
you go back. After import, the new definition appears in the picker. Its tile
|
||||
waits for the board to be saved before server requests run and loads automatically after a successful save; no page
|
||||
reload is required.
|
||||
confirm API sources and credentials. After import, the new definition appears in the picker. Its tile waits for the board
|
||||
to be saved before server requests run.
|
||||
|
||||
## Import and Workshop
|
||||
|
||||
@@ -131,6 +134,7 @@ replace the v1 backup.
|
||||
|
||||
## Bundled examples
|
||||
|
||||
Homarr seeds five disabled examples without credentials and never overwrites an edited seed. They use the same public contract. The Tautulli example is the highest-scoring widget preserved from Homarr's AI authoring evaluation:
|
||||
Homarr seeds five disabled examples without credentials and never overwrites an edited seed. They use the same public
|
||||
contract. Tautulli Activity is one of the bundled examples preserved from Homarr's AI authoring evaluation:
|
||||
|
||||
<BundledCustomWidgetGallery />
|
||||
Reference in new issue
Block a user