fusion-help-docs

Publish help documentation to Fusion Help environments using the fhelp CLI.

1|Updated Feb 18, 2026
One-click install
npx skills add https://github.com/equinor/fusion-skills --skill fusion-help-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: fusion-help-docs
Source: https://github.com/equinor/fusion-skills/tree/main/skills/fusion-help-docs
Command: npx skills add https://github.com/equinor/fusion-skills --skill fusion-help-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) and assets (resource) components.

What problem does it solve?

Guides teams to consistently author, structure, and publish help documentation for Fusion applications, removing uncertainty about file layout, config requirements, and publishing steps.

Core Features & Use Cases

  • Config-driven publishing: Create and validate help-articles.json and help-release-notes.json to map slugs to markdown files.
  • Markdown and asset guidance: Enforce slug-to-filename conventions, require PNG images in images/ folders, and recommend a standard docs/help/ layout.
  • CLI-driven sync: Use the fhelp CLI to authenticate via Azure, upload images, rewrite CDN paths, and push articles, release notes, or FAQs to ci, fqa, tr, or fprd environments.
  • Use cases: Onboard a new app's documentation, prepare release notes for a new version, migrate UI-created articles with care, and automate publishing in CI/CD.

Quick Start

Create a new article file and config entry for app key my-app, then authenticate with Azure and run the fhelp article sync command to push the article to the ci environment.

Frequently Asked Questions about fusion-help-docs

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I publish help documentation to the Fusion platform?

To publish help documentation to Fusion, prepare markdown articles and JSON config files, then use the fhelp CLI to authenticate with Azure and sync content to environments like ci, fqa, tr, or fprd.

What format do help articles and release notes need for Fusion publishing?

Help articles and release notes require markdown files mapped by slugs in JSON config files, with PNG images stored in images/ folders and matching slug-to-filename conventions for validation.

How do I migrate UI-created help articles to a repository workflow?

Migrate UI-created help articles by preparing repository files and using the fhelp CLI with the optional --no-validation flag to override validation and sync existing content to Fusion environments.

Do I need Azure credentials to sync content with the fhelp CLI?

Yes, the fhelp CLI requires Azure DefaultAzureCredential authentication to upload images, rewrite CDN paths, and push articles or release notes to the Fusion Help platform.

Can I automate Fusion help documentation publishing in CI/CD pipelines?

Automate Fusion help documentation publishing in CI/CD by running the fhelp CLI to sync articles, release notes, and FAQs from repository-based workflows to ci, fqa, tr, or fprd environments.

Why does my help documentation sync fail validation?

Help documentation sync fails validation when slug-to-filename conventions are mismatched, PNG images are missing from images/ folders, or JSON config files are incorrectly structured.