fusion-help-docs

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.