Helpgenai.Runtime.Blazor 1.0.1

Helpgenai.Runtime.Blazor

License: Polyform Free Trial 1.0.0. Free to evaluate for 32 consecutive days from first install. After that, any continued use (commercial, internal, personal — all of it) requires a paid license. Contact chrisadam059@gmail.com. See LICENSE.

The Blazor runtime that displays help bundles produced by the helpgenai engine. Drop this NuGet package into your Blazor Server (or hybrid) app and you can render any helpgenai-generated page — metadata, prose, typed reference panels, screenshots, search, an in-app editor, and an admin settings UI — without hand-authoring help UI per page.

The visual language is Stripe / Mintlify editorial: white surface, narrow reading column (720px), section panels with subtle borders, a sticky right-side TOC, lightbox-able screenshots, and a muted accent palette. The runtime ships its own CSS scoped to .help-runtime and does not depend on the host app's framework (Bootstrap, Tailwind, etc.) — your help pages look the same regardless of what your host app uses.

This package is closed-source proprietary. Commercial use requires a license. See LICENSE in the package root or email chrisadam059@gmail.com.

Install

dotnet add package Helpgenai.Runtime.Blazor

The package depends on the helpgenai npm engine, which you install in your help workspace separately:

cd tools/helpgen
npm i helpgenai

What the package ships

Display components:

• MarkdownHelpContent — renders a page's .md content with per-section editing support.
• Components/Panels/IconLegendPanel — renders icons.json as an editorial reference table.
• Components/Panels/CellStatesPanel — renders cell-states.json as a grouped state reference.
• Components/Panels/StatusReferencePanel — renders status enums.

Editing components:

• Components/GuidanceEditorModal — page-level + per-section AI authoring direction.
• Components/Admin/HelpAdminPanel — admin settings UI (edit helpmap.yaml, styleguide.yaml, hints/*.yaml, CONTENT-STYLE.md without touching files).

Services:

• IHelpContentLocator + FileSystemHelpContentLocator
• IHelpConfigService + FileSystemHelpConfigService
• IHelpGuidanceService + HelpGuidanceService
• IHelpEditAuthorizer (you implement; gates all editing)
• HelpSectionEditor, HelpMapService, PageHelpState

Static assets:

• _content/Helpgenai.Runtime.Blazor/css/page-help.css
• _content/Helpgenai.Runtime.Blazor/js/page-help.js

Minimal wiring (Blazor Server)

// Program.cs
using Helpgen.Runtime.Blazor.Services;

builder.Services.AddSingleton<IHelpContentLocator>(sp =>
{
    var env = sp.GetRequiredService<IWebHostEnvironment>();
    var helpgenRoot = Path.GetFullPath(
        Path.Combine(env.ContentRootPath, "tools", "helpgen"));
    return new FileSystemHelpContentLocator(env.WebRootPath, helpgenRoot);
});
builder.Services.AddSingleton<IHelpGuidanceService, HelpGuidanceService>();
builder.Services.AddSingleton<IHelpConfigService>(sp =>
{
    var env = sp.GetRequiredService<IWebHostEnvironment>();
    var helpgenRoot = Path.GetFullPath(
        Path.Combine(env.ContentRootPath, "tools", "helpgen"));
    return new FileSystemHelpConfigService(helpgenRoot);
});
builder.Services.AddScoped<IHelpEditAuthorizer, MyHelpEditAuthorizer>();
builder.Services.AddScoped<PageHelpState>();
builder.Services.AddScoped<HelpMapService>();

<link rel="stylesheet" href="_content/Helpgenai.Runtime.Blazor/css/page-help.css" />
<script src="_content/Helpgenai.Runtime.Blazor/js/page-help.js"></script>

@* Components/Pages/HelpPageView.razor *@
@page "/help/{PageKey}"
@using Helpgen.Runtime.Blazor.Components

<div class="help-runtime">
    <div class="help-page">
        <MarkdownHelpContent PageKey="@PageKey" EditMode="@_editMode" />
        @* Plus your own section dispatch for icon-legend / cell-states / etc. *@
    </div>
</div>

See the examples/blazor-todo app for complete wiring including the help index page, /help/_admin/settings route, and Razor route constraints.

Compatibility

• .NET 8 target. .NET 9+ should work but isn't tested.
• Pairs with helpgenai engine 0.2.x. The engine version and runtime major version track each other.
• Blazor Server only today; WASM + Maui Hybrid need an HTTP-fetching IHelpContentLocator that doesn't ship yet.

Contract

• The runtime READS files at paths the locator resolves to.
• The runtime WRITES guidance files (IHelpGuidanceService.Write*Async), prose edits (HelpSectionEditor), and admin-edited YAML (IHelpConfigService.Save*Async) directly to disk — all Blazor Server only.
• The runtime does NOT call any LLM, run the build, or capture screenshots. Those are the engine + your chosen LLM host's job.

Links

• Engine on npm: https://www.npmjs.com/package/helpgenai
• Reference Claude Code host: https://www.npmjs.com/package/helpgenai-host-claude-code
• Repo (private): contact chrisadam059@gmail.com for source access