NextGuide Add-ons

NextGuide Add-ons

Build, publish and maintain extensions for NextGuide Account Mode.

NextGuide Add-ons

A dedicated place for creating and maintaining NextGuide add-ons, from simple documentation content to the future permissioned TypeScript/React extension system. Add-ons use the existing single nextguide package; there is no second SDK to install.

What works today

The developer publisher supports GitHub App sign-in, repository selection, preflight validation, submissions, updates, and withdrawal. Review is handled separately. The private ngapi registry signs its approved catalog. Only content-only v1 add-ons can be published today. The Account Mode marketplace installer and isolated executable runner are still in development.

Start here

The add-on system we're building

FunctionCurrent state
Create and package Markdown content add-onsSupported by the template
Publish, review, approve, update and withdraw add-onsWorking through ngapi Publisher
Signed registry and revocationWorking through ngapi
Capability contracts and trusted extension hostAvailable in NextGuide source
Host-mediated storage, signed catalog verifier, safe UI descriptorsAvailable as foundation APIs
Execute third-party React, TypeScript or server scriptsNot supported yet
Browse and install add-ons inside Account ModeNot supported yet

The extension host is not a security sandbox. Executable add-ons require a separate isolated runner, verified artifacts and owner-approved permissions before we can offer them in the marketplace.

Executable v2 developer and review track

The official add-on template now provides a complete offline v2 JavaScript/TypeScript developer lab, including Bun compilation, deterministic archive packaging, source-bound SHA-256 and an example brokered admin page. NextGuide itself can verify short-lived, independently signed v2 review metadata, the exact archive, source and compiled bytes, and safely download them through a DNS-pinned GitHub asset transport.

This does not make executable packages publishable through the current v1-only private ngapi registry or installable in Account Mode. See Reviewed v2 packages for the signed protocol and remaining security gates.

Documentation routes

Add-on developer docs live under /addons with a dedicated sidebar, search, and page navigation. For framework basics, visit NextGuide documentation; for UI component examples, see the component catalog.

GitHub App publisher · Add-ons repository template · Roadmap