You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Orderly publishes agent skills (install via `orderly-devkit skills install`) for **`orderly-plugin-create`**, **`orderly-plugin-write`**, **`orderly-plugin-add`**, **`orderly-plugin-submit`** (source repo: **`OrderlyNetwork/orderly-skills`**, per devkit constants).
7
7
8
-
**Recommended usage:** See [**Skills-first workflow**](skills-first) for why skills + MCP + devkit are the preferred stack for Orderly plugin work.
8
+
**Recommended usage:** See [**Skills-first workflow**](/build-on-omnichain/module-marketplace/skills-first) for why skills + MCP + devkit are the preferred stack for Orderly plugin work.
9
9
10
10
This handbook is the **in-repo, versioned** companion. If you maintain skills in that external repo, keep the following in sync with shipping CLIs and MCP.
11
11
@@ -21,7 +21,7 @@ Some older or external skills mention **`orderly_docs_get_hook`**. The `@orderly
Skills may ship extended placeholder tables. **Runtime paths** in this handbook: [Runtime injector targets](runtime-injector-targets) and [Interceptors](interceptors). CLI template subset is listed on the same page.
36
+
Skills may ship extended placeholder tables. **Runtime paths** in this handbook: [Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets) and [Interceptors](/build-on-omnichain/module-marketplace/interceptors). CLI template subset is listed on the same page.
Copy file name to clipboardExpand all lines: build-on-omnichain/module-marketplace/first-plugin.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@ description: "Goal: Scaffold a plugin and make one visible change on a single in
5
5
6
6
**Goal:** Scaffold a plugin and make **one** visible change on a **single** interceptor target that exists in the SDK.
7
7
8
-
**Prerequisite:**[Getting started](getting-started) completed (includes **`orderly-devkit skills install`** and **`mcp install`** if you use an agent).
8
+
**Prerequisite:**[Getting started](/build-on-omnichain/module-marketplace/getting-started) completed (includes **`orderly-devkit skills install`** and **`mcp install`** if you use an agent).
9
9
10
10
## Using agent skills for this tutorial
11
11
12
-
Install the default plugin skills once — see [Skills-first workflow](skills-first). For this tutorial the relevant skills are:
12
+
Install the default plugin skills once — see [Skills-first workflow](/build-on-omnichain/module-marketplace/skills-first). For this tutorial the relevant skills are:
13
13
14
14
| Skill | What it covers | CLI / tool it leads you to |
15
15
| --- | --- | --- |
@@ -24,19 +24,19 @@ You can still run **`orderly-devkit create plugin`** by hand; the skill is the s
24
24
25
25
## 1. Pick a target path
26
26
27
-
Valid runtime targets are listed in **[Runtime injector targets](runtime-injector-targets)** (paths must match **exactly**, case-sensitive).
27
+
Valid runtime targets are listed in **[Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets)** (paths must match **exactly**, case-sensitive).
28
28
29
29
For this tutorial, use a target you know appears on your trading page—for example `Trading.OrderEntry.SubmitSection` or another row from that page.
30
30
31
-
> **Note:**`orderly-devkit create plugin --interceptor` only offers a **subset** of SDK targets. You can still register interceptors for any runtime path in [Runtime injector targets](runtime-injector-targets) by editing the generated plugin code.
31
+
> **Note:**`orderly-devkit create plugin --interceptor` only offers a **subset** of SDK targets. You can still register interceptors for any runtime path in [Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets) by editing the generated plugin code.
32
32
33
33
## 2. Create the project
34
34
35
35
```bash
36
36
orderly-devkit create plugin
37
37
```
38
38
39
-
Answer the prompts, or use `--no-interactive` with `--name`, `--id`, `--interceptor`, and `--target` as in [Getting started](getting-started).
39
+
Answer the prompts, or use `--no-interactive` with `--name`, `--id`, `--interceptor`, and `--target` as in [Getting started](/build-on-omnichain/module-marketplace/getting-started).
40
40
41
41
## 3. Implement one small behavior
42
42
@@ -62,7 +62,7 @@ interceptors: [
62
62
],
63
63
```
64
64
65
-
**Important:** The `component` function is **not** a React component—do not call Hooks directly on it. Return JSX that uses inner components if you need Hooks (see [Interceptor strategies](interceptor-strategies)).
65
+
**Important:** The `component` function is **not** a React component—do not call Hooks directly on it. Return JSX that uses inner components if you need Hooks (see [Interceptor strategies](/build-on-omnichain/module-marketplace/interceptor-strategies)).
66
66
67
67
## 4. Build the package
68
68
@@ -78,14 +78,14 @@ Adjust commands to match the template’s `package.json`.
78
78
79
79
## 5. Integrate in a host (smoke test)
80
80
81
-
Follow [Tutorial 2: Integrate into host](integrate-host) to add `plugins={[registerYourPlugin()]}` on `OrderlyAppProvider`.
81
+
Follow [Tutorial 2: Integrate into host](/build-on-omnichain/module-marketplace/integrate-host) to add `plugins={[registerYourPlugin()]}` on `OrderlyAppProvider`.
82
82
83
83
**Verification:** Navigate to the trading view and confirm your UI change appears at the interceptor location.
84
84
85
85
## Failure recovery
86
86
87
87
| Issue | Action |
88
88
| --- | --- |
89
-
| Target not found / no effect | Re-read the target against [Runtime injector targets](runtime-injector-targets); typos break injection. |
90
-
| Hooks error in interceptor | Move Hook usage into a child component; see [How-to: Interceptor strategies](interceptor-strategies). |
91
-
| Scaffold mismatch | Regenerate or trim generated files to the minimal **`registerPlugin`** shape; see **[Plugin types](plugin-types)** and **`@orderly.network/plugin-core`** on npm for full architecture. |
89
+
| Target not found / no effect | Re-read the target against [Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets); typos break injection. |
90
+
| Hooks error in interceptor | Move Hook usage into a child component; see [How-to: Interceptor strategies](/build-on-omnichain/module-marketplace/interceptor-strategies). |
91
+
| Scaffold mismatch | Regenerate or trim generated files to the minimal **`registerPlugin`** shape; see **[Plugin types](/build-on-omnichain/module-marketplace/plugin-types)** and **`@orderly.network/plugin-core`** on npm for full architecture. |
Copy file name to clipboardExpand all lines: build-on-omnichain/module-marketplace/getting-started.mdx
+10-10Lines changed: 10 additions & 10 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: "Follow this path once per machine or project. Estimated time: 15
5
5
6
6
Follow this path once per machine or project. Estimated time: **15–20 minutes**.
7
7
8
-
For **why** we recommend installing **skills + MCP** alongside the CLI—and how the four Orderly plugin skills fit the SDK workflow—read [**Skills-first workflow**](skills-first) first.
8
+
For **why** we recommend installing **skills + MCP** alongside the CLI—and how the four Orderly plugin skills fit the SDK workflow—read [**Skills-first workflow**](/build-on-omnichain/module-marketplace/skills-first) first.
9
9
10
10
## Requirements
11
11
@@ -43,7 +43,7 @@ orderly-devkit skills install --list # list only
43
43
orderly-devkit skills install --dry-run # preview
44
44
```
45
45
46
-
Use **`--agent cursor`** (or your client) when you need skills installed for a specific agent—see [CLI reference: skills](cli-reference#skills-install).
46
+
Use **`--agent cursor`** (or your client) when you need skills installed for a specific agent—see [CLI reference: skills](/build-on-omnichain/module-marketplace/cli-reference#skills-install).
47
47
48
48
**Without an AI agent**, this step is optional; you can rely on the CLI and docs alone. With an agent, **treat this as part of the default stack** together with the MCP below.
49
49
@@ -61,7 +61,7 @@ or the sdk-docs binary directly:
61
61
pnpm dlx @orderly.network/sdk-docs orderly-sdk-docs-mcp install --client all --scope user
62
62
```
63
63
64
-
See [Orderly SDK Docs MCP](mcp-sdk-docs) for tools and the `install` subcommand.
64
+
See [Orderly SDK Docs MCP](/build-on-omnichain/module-marketplace/mcp-sdk-docs) for tools and the `install` subcommand.
65
65
66
66
After `orderly-devkit create plugin` or a successful `submit`, the devkit may print hints if the MCP server is not detected (see the published **`@orderly.network/devkit`** sources for MCP detection behavior).
Copy file name to clipboardExpand all lines: build-on-omnichain/module-marketplace/integrate-host.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: "Goal: Load an existing plugin package through OrderlyAppProvider
5
5
6
6
**Goal:** Load an existing plugin package through **`OrderlyAppProvider`**’s `plugins` prop.
7
7
8
-
**Prerequisite:** A plugin package that exports a register function (e.g. `registerMyPlugin()`), either from [Tutorial 1](first-plugin) or published npm. Optional: **`orderly-devkit skills install`** plus [Skills-first workflow](skills-first).
8
+
**Prerequisite:** A plugin package that exports a register function (e.g. `registerMyPlugin()`), either from [Tutorial 1](/build-on-omnichain/module-marketplace/first-plugin) or published npm. Optional: **`orderly-devkit skills install`** plus [Skills-first workflow](/build-on-omnichain/module-marketplace/skills-first).
9
9
10
10
## Using agent skills for this tutorial
11
11
@@ -59,7 +59,7 @@ orderly-devkit login
59
59
orderly-devkit view <plugin-id>
60
60
```
61
61
62
-
Read **`usagePrompt`** first when present—it describes integration steps from the author. The CLI **`view`** command requires authentication today (Bearer token); see [Agent skills alignment](agent-skills-alignment).
62
+
Read **`usagePrompt`** first when present—it describes integration steps from the author. The CLI **`view`** command requires authentication today (Bearer token); see [Agent skills alignment](/build-on-omnichain/module-marketplace/agent-skills-alignment).
63
63
64
64
## 4. Register on `OrderlyAppProvider`
65
65
@@ -96,7 +96,7 @@ grep -r "registerMyPlugin" src/
96
96
97
97
## Layoutplugins
98
98
99
-
Iftheplugintargets**`Trading.Layout.Desktop`**, ensure you understand precedence between plugin layout strategies and host-provided `layoutStrategy` / `getInitialLayout`. See **`@orderly.network/layout-core`** on npm (layout customization docs) and the [plugin types](plugin-types) guide.
99
+
Iftheplugintargets**`Trading.Layout.Desktop`**, ensure you understand precedence between plugin layout strategies and host-provided `layoutStrategy` / `getInitialLayout`. See **`@orderly.network/layout-core`** on npm (layout customization docs) and the [plugin types](/build-on-omnichain/module-marketplace/plugin-types) guide.
Copy file name to clipboardExpand all lines: build-on-omnichain/module-marketplace/interceptor-strategies.mdx
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -55,12 +55,12 @@ Return markup **without** rendering `Original` when you intentionally replace th
55
55
56
56
## Discovering targets
57
57
58
-
Authoritative paths in this handbook: [Runtime injector targets](runtime-injector-targets).
58
+
Authoritative paths in this handbook: [Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets).
59
59
60
60
The devkit template lists a **subset** of targets for `--interceptor` (same page, **create plugin --interceptor subset**); your plugin code may target any injectable path the SDK exposes.
61
61
62
62
## Docs-first development
63
63
64
-
Use the Orderly SDK Docs MCP ([reference](mcp-sdk-docs)) to resolve component APIs: `orderly_docs_search`, then `orderly_docs_get_component` or `orderly_docs_get_type`. For narrative examples: `orderly_docs_get_component_doc`, `orderly_docs_get_workflow`, `orderly_docs_get_recipe`.
64
+
Use the Orderly SDK Docs MCP ([reference](/build-on-omnichain/module-marketplace/mcp-sdk-docs)) to resolve component APIs: `orderly_docs_search`, then `orderly_docs_get_component` or `orderly_docs_get_type`. For narrative examples: `orderly_docs_get_component_doc`, `orderly_docs_get_workflow`, `orderly_docs_get_recipe`.
65
65
66
-
There is **no**`orderly_docs_get_hook` tool in the current server; use search + get_component/get_type instead ([alignment notes](agent-skills-alignment)).
66
+
There is **no**`orderly_docs_get_hook` tool in the current server; use search + get_component/get_type instead ([alignment notes](/build-on-omnichain/module-marketplace/agent-skills-alignment)).
Copy file name to clipboardExpand all lines: build-on-omnichain/module-marketplace/interceptors.mdx
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,11 +5,11 @@ description: "Guide for interceptor targets: runtime vs cli template"
5
5
6
6
## Runtime (SDK)
7
7
8
-
Authoritative path strings for **`interceptors[].target`** live in this handbook: **[Runtime injector targets](runtime-injector-targets)**.
8
+
Authoritative path strings for **`interceptors[].target`** live in this handbook: **[Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets)**.
The CLI exposes a **fixed subset** for scaffolding prompts only—see the **create plugin --interceptor subset** section in [Runtime injector targets](runtime-injector-targets).
12
+
The CLI exposes a **fixed subset** for scaffolding prompts only—see the **create plugin --interceptor subset** section in [Runtime injector targets](/build-on-omnichain/module-marketplace/runtime-injector-targets).
0 commit comments