fusion-help-integration

Original：🇺🇸 English

Translated

Wires Fusion Help Center into app pages — creates article slug constants, adds useHelpCenter hook, and connects PageLayout props so users can open contextual help articles. USE FOR: add help button to page, wire useHelpCenter, create helpArticles constants, integrate Fusion Help in app, connect PageLayout to help center, add openHelpArticle to page. DO NOT USE FOR: authoring markdown help articles (use fusion-help-docs), direct Help REST API calls (use fusion-help-api), modifying @fra/ui shared components.

21installs

Sourceequinor/fusion-skills

Added on2026-03-24

NPX Install

npx skill4agent add equinor/fusion-skills fusion-help-integration

SKILL.md Content

View Translation Comparison →

Fusion Help Integration

Wire the Fusion Help Center into app pages so users can open contextual help articles via the PageLayout help button.

When to use

User wants to add a help button to a page
User wants to wire
```
useHelpCenter
```
into a page component
User wants to create or update the help articles constants file for an app
User asks how to connect
```
PageLayout
```
to the Fusion Help Center
Agent detects a page using
```
PageLayout
```
without
```
openHelpArticle
```
User wants to add help support to an app that doesn't have it yet
User asks "how do I open a specific help article from my page?"

When not to use

Authoring markdown help article content → use
```
fusion-help-docs
```
skill
Making direct REST API calls to the Help service → use
```
fusion-help-api
```
skill

Modifying

@fra/ui

shared components (

PageLayout

,

PageHeader

,

FusionHelpButton

)

Non-Fusion-framework apps or apps outside this monorepo

Required inputs

Collect before making changes:

Input	Required	Default	Description
App name	Yes	—	The app directory name under `apps/` (e.g., `fra-app-management` )
Target pages	Yes	—	Which page(s) to wire up, or `"all"` for every page using `PageLayout`
Article slugs	Yes	Auto-derive	Slug strings for each page. If not provided, derive as `{app-name}-{page-kebab}`
Include release notes	No	`true`	Whether to also pass `openReleaseNotes` to `PageLayout`
Constants file location	No	`src/constants/helpArticles.ts`	Path for the `FUSION_HELP_ARTICLES` object

If article slugs are auto-derived, confirm them with the user before applying — slugs must match articles published via the

fhelp

CLI.

Instructions

1. Check existing help integration

Search the target app for existing help wiring:

apps/{app-name}/src/**/helpArticles.ts
apps/{app-name}/src/**/fusionHelpArticles.ts

Also search for

useHelpCenter

imports. If the app already has partial integration, extend it rather than duplicating.

2. Determine slug convention

Check if the app already has a constants file with slugs:

Has existing slugs → follow its naming pattern (prefixed vs. unprefixed)
No existing slugs → use
```
{app-name}-{page-kebab}
```
convention

Reference existing conventions:

App	Convention	Example
`fra-access-manager`	`{app-name}-{page-kebab}`	`fra-access-manager-access-groups`
`fra-app-management`	Unprefixed page name	`overview` , `requests`
`personnel-allocation`	`{app-name}-{page-kebab}`	`personnel-allocation-overview`

Prefer the prefixed convention for new apps — it avoids slug collisions across apps.

3. Create or update the constants file

Create

src/constants/helpArticles.ts

(or the app's chosen location):

typescript

export const FUSION_HELP_ARTICLES = {
    PAGE_NAME: '{app-name}-{page-kebab}',
};

Keys are

SCREAMING_SNAKE_CASE

matching the page concept. Values are kebab-case slug strings.

See references/wiring-pattern.md for the full canonical pattern with real examples.

4. Wire each target page

For each page component that uses

PageLayout

:

a. Add imports (respecting the project's import order — externals first, then

@fra/*

, then

@/*

aliases, then relative):

typescript

import { useHelpCenter } from '@equinor/fusion-framework-react-app/help-center';

import { PageLayout } from '@fra/ui';

import { FUSION_HELP_ARTICLES } from '@/constants/helpArticles';

b. Destructure the hook inside the component body:

typescript

const { openArticle, openReleaseNotes } = useHelpCenter();

If release notes are not needed, destructure only

{ openArticle }

.

c. Pass props to
PageLayout
:

tsx

<PageLayout
    title="Page Title"
    openHelpArticle={() => openArticle(FUSION_HELP_ARTICLES.PAGE_NAME)}
    openReleaseNotes={openReleaseNotes}
>

Important:

openHelpArticle

must be a callback wrapper

() => openArticle(slug)

, not a direct reference —

openArticle

requires the slug argument.

5. Verify the integration

After wiring:

Run TypeScript check:

pnpm --filter {app-name} exec tsc --noEmit

Confirm no lint errors:

pnpm --filter {app-name} exec eslint src/

Visually verify: the page header should show an info-circle (ⓘ) icon button. Clicking it opens the Fusion Help sidesheet.

6. Cross-reference with published content

Remind the user that each slug in

FUSION_HELP_ARTICLES

must correspond to a published article. If the articles don't exist yet:

Point to the
```
fusion-help-docs
```
skill for authoring content
The slug in the constants file must exactly match the
```
slug
```
field in the
```
help-articles.json
```
config
Articles are published per-environment via the
```
fhelp
```
CLI

Expected output

Constants file created/updated with article slug mappings
Target page(s) wired with
```
useHelpCenter
```
hook and
```
PageLayout
```
props
TypeScript compilation passes
List of slugs that need corresponding help articles (for handoff to
```
fusion-help-docs
```
)

Safety & constraints

Never invent slug names without user confirmation — slugs must match published articles
Don't modify
@fra/ui
components —
```
PageLayout
```
,
```
PageHeader
```
, and
```
FusionHelpButton
```
already support help props
Don't add new dependencies —
```
@equinor/fusion-framework-react-app
```
is already a dependency of every app
Follow the app's existing import alias convention — most apps use
```
@/*
```
→
```
src/*
```
Respect existing code style — use
```
type
```
keyword for type-only imports, maintain import group ordering
Don't duplicate help wiring — if a page already has
```
useHelpCenter
```
, extend rather than re-add
Confirm auto-derived slugs before applying — a wrong slug silently fails (no article shown)

fusion-help-integration

NPX Install

Tags

SKILL.md Content

Fusion Help Integration

When to use

When not to use

Required inputs

Instructions

1. Check existing help integration

2. Determine slug convention

3. Create or update the constants file

4. Wire each target page

5. Verify the integration

6. Cross-reference with published content

Expected output

Safety & constraints