ERP Plugin Developer Documentation

This is the tenant-facing documentation set for building plugins on the ERP platform with the plugin SDK (the erp CLI + the erp-plugin-language MCP server). You do not need access to the platform source to build a plugin — everything the tools need to ground you (schemas, the engine-capability catalog, curated examples, these docs) ships in an authoring bundle that the SDK reads offline, and can be refreshed from your ERP with erp env sync.

How this is organized (Diátaxis)

Folder	Purpose
quickstart/	Get from zero to a published, live one-page plugin.
concepts/	Plain-language mental models — artifact types, the plugin lifecycle, the SDK modes, how a page gets its data, plus a glossary.
guides/	Task-focused how-tos, one page per task. Each: what you're building → a complete real example → line-by-line walkthrough → how to verify → common mistakes → what to read next.
reference/	One generated page per authoring-artifact JSON Schema. Regenerated by erp docs gen-reference.
tutorial/	One end-to-end walkthrough — build and publish the Office Equipment module (8 chapters). Its finished source ships at tutorial/example-plugin/.
recipes/	Short copy-paste solutions to recurring shapes, drawn from the erp examples patterns catalog.
examples/	Standalone artifact files + the CI runner that keeps every code sample honest.
troubleshooting/	Known gotchas (symptom → cause → fix) and focused pages for the common "it's silently broken" situations.

How the examples stay honest

Every JSON artifact shown in a guide, recipe, or tutorial chapter is a real file — no ... elisions in a primary example — living in tutorial/example-plugin/spk-assembly/ (the published, verified tutorial module) or examples/standalone-plugin/spk-assembly/. One runner validates them all:

node developer-docs/examples/test-examples.mjs

It schema-validates every entity / provider / data-service / data-view / rule / workflow / menu / seed-data file against the live SDK schemas and runs erp plugin test on the tutorial module. Run it in CI on every change to developer-docs/ — a broken example fails the build.

The quality bar for every page here

1. Plain-language description first — what this is and when you'd reach for it, before any syntax.
2. One complete, runnable example — every code sample is a real file that has actually been validated/tested, not a sketch.
3. One page per task — a "how do I X" page answers exactly X.
4. Every command is real — copy-paste it and it works against the current erp CLI.

Not in this tree

Platform-internal (platform-developer) documentation lives in the monorepo's ai/ tree and is never bundled or published to tenants. See docs-platform/README.md for that split.

Browsing this content

• Offline, from the installed SDK: erp docs serve (see @erp/plugin-sdk, packages/erp-plugin-sdk/) runs a small local preview server over this tree (or the bundle's/synced copy of it in a packaged install) — no repo needed.
• The future hosted website: website/ at the repo root is a VitePress scaffold built from this tree + docs.json's own nav (never hand-duplicated — see website/.vitepress/config.mjs). npm install && npm run build in website/ produces a static dist/ today; an actual public deploy (Vercel/Netlify/GitHub Pages) is intentionally out of scope until that's greenlit — see low-code-docs/REMOTE-SDK-BATCH-C-D-STATUS.md.