Documentation

The real documentation lives in one place — this page points to it.

Spark ERP's developer documentation is a genuine Diátaxis-structured doc set (Getting Started, Concepts, Guides, Recipes, Reference, Tutorial), built and shipped alongside @erp/plugin-sdk. This page is an overview and a signpost, not a second copy of that content.

How to browse it today

The documentation site (built with VitePress) is not yet deployed to a public URL. Until it is, browse the full, real doc set locally: install @erp/plugin-sdk (see the Developers quick start) and run `erp docs serve` — it serves the exact same content this site will host, offline, from your machine.

erp docs serve                  # local offline dev-preview, sidebar from docs.json's nav
erp docs search "create a tenant"   # search the doc set from the CLI, no server needed

Getting Started

Install the SDK, log in, and understand the two SDK modes (packaged vs. monorepo).

Quickstart
SDK modes
Set up the SDK

Concepts

How the platform is put together, at the level a plugin author needs.

Platform overview
Artifact types
Plugin lifecycle
Page data flow
Glossary

Guides

Task-oriented, one page per job — the largest section of the real doc set.

Create a plugin
Build a page
Add an entity
Add a data provider
Add an approval workflow
Add business rules
Add a KPI
Add i18n
Add menus
Wire a page's data
Validate and test
Publish and upgrade
Use the MCP server
Build a responsive plugin
Build a tenant extension service
Seed data on install

Recipes

Worked, end-to-end patterns that combine several guides.

Entity with an approval workflow
Master-detail page
KPI dashboard page
Cross-row aggregation
Scheduled record generation
N-days-before reminder
Resolved-reference grid column
Related-record lookup field
Per-row document generator
Condition-based compliance flag
Cross-plugin offboarding fan-out
Install-lifecycle data seeding

Reference

Every artifact schema a plugin can ship, one page each — generated from the platform's real JSON Schemas.

Plugin manifest
Entity definition
Page
Form
Menu
Rule
Workflow definition
Data service / data view definition
Connector definition
Report definition
Print template definition
Block definition / instance
and more — one page per schema

Tutorial

An 8-step, start-to-finish walkthrough building one real plugin.

Create the plugin
Category entity + seed
Equipment entity
Equipment register page
Checkout entity + page
Checkout approval workflow
Return-due reminder job
Menus, i18n, publish

Troubleshooting

Known gotchas and the fixes for the errors developers actually hit.

Grid shows zero rows
Job never runs
Publishing errors
Known gotchas

Prefer a live example first?

The API Reference shows the same authentication and request shape the docs use, with real endpoint examples.

View API Reference Developer Home