> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gloo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Contextual Help

> Get task-focused guidance without leaving the Forge Console work in front of you.

Forge Console Help explains the work in front of you without sending you to a separate support
flow. Guidance opens beside the current task on desktop and as a focused sheet on smaller screens,
so your page, draft, form values, and conversation remain intact.

![Help open beside Traces (light)](https://mintcdn.com/gloo-b243725a/RWLRJhy-posoUzeW/forge/images/console/help-light.png?fit=max\&auto=format\&n=RWLRJhy-posoUzeW\&q=85\&s=9cfb09c2e9e2103790c390f0c2b55649)

Help open beside Traces — Forge Console at `/observe/traces`

## What you can do

* Open Help for the current page, for one field or action, or from the command palette. See [Open the right guidance](#open-the-right-guidance).
* Search Help, follow related topics, copy a deep link or open the full documentation. See [Work inside the Help surface](#work-inside-the-help-surface).
* Tell maintainers whether a topic helped with **Was this helpful?**

## Open the right guidance

You can enter Help at three levels:

| Entry point | Use it when | What opens |
| - | - | - |
| **Question-mark button in the Console shell** | You need an overview of the current page. | The most specific topic Forge can resolve from the current route and active workspace context. |
| **Question-mark button beside a field or action** | A term, value, or consequence is unclear. | Guidance anchored directly to that concept, such as workflow Parameter, Derived, and Asset inputs. |
| **Command palette (`⌘K` / `Ctrl+K`) → Help for this page** | Your hands are already on the keyboard or the shell is collapsed. | The same current-page guidance as the global button. |

Hovering or focusing a question-mark button shows its subject. Activating it opens Help; hover
alone never interrupts your work.

> [!TIP]
>
> Start with the closest question mark. A field-level trigger is more precise than the page-level
> trigger, and Help always keeps the broader page topics available through search and related links.

## Work inside the Help surface

Every Help topic provides a compact set of tools:

* **Search Help** searches only guidance you are allowed to see in the current Console session.
* **Related Help** follows the authored next steps without losing the page underneath.
* **Copy link** creates a deep link to the current topic and, when applicable, its exact subsection.
* **Open full documentation** moves to the longer operational or conceptual reference when the
  current task needs more depth.
* **Was this helpful?** records a simple Yes or No signal so maintainers can improve weak guidance.

The copied URL keeps the normal page path and adds the Help topic. A teammate who has access to the
same Console area can open the link and land on the same guidance. Help does not grant access: if
the recipient lacks the required permission or feature, Forge opens Help home and reports that the
requested topic is unavailable.

## Keep control of focus and Escape

Help follows the Console's normal keyboard rules:

* On desktop, Help is a sidecar and does not trap focus away from the page.
* On smaller screens, Help is a modal sheet and keeps focus inside it until closed.
* If the Help search contains text, **Escape clears the search first**. Press Escape again to close
  Help.
* Closing Help restores focus to the control that opened it when that control still exists.
* Reduced-motion preferences disable nonessential Help transitions.

## Example: workflow Inputs

In the workflow builder, open the **Inputs** tab and use the question mark beside the input contract
or an individual input kind.

| Input kind | Use it for | Who supplies the value |
| - | - | - |
| **Parameter** | A value the caller knows when starting the run. | The operator, schedule, API caller, or ingress request. |
| **Derived** | A value calculated from other declared inputs. | Forge evaluates the declared expression; the caller does not type it again. |
| **Asset** | A managed file or durable platform asset. | The run uses the bound asset, subject to the workflow's replacement permissions. |

When launching a workflow, Help remains available beside the run form. It explains why derived
values are read-only, whether an asset is bound, and when a manager may replace that binding before
dispatch.

## If guidance cannot load

Help fails locally and safely:

* An invalid, removed, or unauthorized deep link falls back to Help home instead of revealing the
  hidden topic.
* A content-load failure leaves the current Console page usable and offers a retry.
* Search can return **No results** without changing the current topic.
* Full documentation remains a separate link when the embedded article is intentionally concise.

If a topic is inaccurate, choose **No** under **Was this helpful?** and use **Copy link** when
reporting the issue. The copied link identifies the exact topic without including form values,
search text, or page content.

## Key state to watch

* **Help home instead of the linked topic** — the link was invalid or removed, or you lack the permission or feature it needs.
* **Escape with search text** — the first Escape clears the search; the second closes Help.
* **Search results** — they cover only guidance you may see in the current session.

## Related

* [Forge Console overview](https://docs.gloo.com/forge/console.md)
* [Workflows](https://docs.gloo.com/forge/console/production/workflows)
* [Trust Fabric](https://docs.gloo.com/forge/console/trust-fabric.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.