Skip to content

Open-source manufacturing ERP, MES and QMS. Quoting, MRP, inventory, shop floor, quality and lot/serial traceability on one Postgres schema, with a REST API and MCP server. Self-host or use Carbon Cloud.

docs: keyboard shortcuts page, and Workflow Runs record names

aashua9d0874dc502
diff --git a/apps/erp/app/modules/agent/kb/docs/integrations/project-management.md b/apps/erp/app/modules/agent/kb/docs/integrations/project-management.md
index c3fca675b0..5c16fa90b4 100644
--- a/apps/erp/app/modules/agent/kb/docs/integrations/project-management.md
+++ b/apps/erp/app/modules/agent/kb/docs/integrations/project-management.md
@@ -11,6 +11,19 @@ to an external issue and keep the two in step, status, assignee, and notes sync
Authenticate with a **Linear API key** (it begins with `lin_api`).
+ ### Create the webhook in Linear
+
+ In Linear's API settings, create a new webhook and paste the URL shown in Carbon's setup instructions
+ (`/api/webhook/linear/<your company id>`). This is how changes made in Linear reach Carbon.
+
+
+ ### Copy the signing secret
+
+ Linear shows a **signing secret** on the webhook's detail page. Paste it into **Webhook Signing Secret**.
+ With it saved, Carbon only accepts webhook requests Linear has signed, and rejects any that are more
+ than a minute old.
+
+
### Paste your Linear API key
Provide your Linear API key. Carbon checks the `lin_api` prefix.
@@ -24,15 +37,28 @@ Authenticate with a **Linear API key** (it begins with `lin_api`).
| Setting | What it controls |
| --- | --- |
| API key | Your Linear API key — Carbon checks the `lin_api` prefix. |
+| Webhook signing secret | Optional. When set, webhook requests without a valid Linear signature are rejected. |
+
+A Linear or Jira webhook with no secret saved in Carbon still works, so older setups keep syncing, but
+Carbon cannot tell its requests from forged ones. Add the secret to every webhook you create.
## Jira
-Connect over **OAuth**. There are no fields to fill in beyond authorizing Carbon.
+Connect over **OAuth**. The only setting is an optional webhook secret.
### Authorize over OAuth
- Authorize Carbon in Jira. There are no fields to fill in.
+ Authorize Carbon in Jira.
+
+
+ ### Create the webhook in Jira (optional)
+
+ For changes made in Jira to reach Carbon straight away, go to **System → WebHooks** in Jira and create a
+ webhook with the URL shown in Carbon's setup instructions (`/api/webhook/jira/<your company id>`),
+ subscribed to **Issue updated** and **Issue deleted**. Fill in the webhook's **Secret** field, and paste
+ the same value into **Webhook Secret** in Carbon. With it saved, Carbon only accepts webhook requests
+ Jira has signed.
### Link an action task
@@ -40,6 +66,10 @@ Connect over **OAuth**. There are no fields to fill in beyond authorizing Carbon
Once connected, you can link a nonconformance action task to a Jira issue, and status, assignee, and notes stay aligned in both directions.
+| Setting | What it controls |
+| --- | --- |
+| Webhook secret | Optional. When set, webhook requests without a valid Jira signature are rejected. |
+
Jira only appears when its OAuth client is configured server-side (`JIRA_CLIENT_ID`) — see
`docs/platform/self-hosting/environment-variables`.
diff --git a/apps/erp/app/modules/agent/kb/docs/reference/keyboard-shortcuts.md b/apps/erp/app/modules/agent/kb/docs/reference/keyboard-shortcuts.md
new file mode 100644
index 0000000000..3f9c7506c7
--- /dev/null
+++ b/apps/erp/app/modules/agent/kb/docs/reference/keyboard-shortcuts.md
@@ -0,0 +1,53 @@
+# Keyboard shortcuts
+
+> Jump between modules, page through tables, and run menu actions from the keyboard, with the full list one keypress away.
+
+Most of what you do with the mouse in Carbon has a key. Press **?** on any page to open the full list. Shortcuts are ignored while you type in a field, so they never interrupt a form.
+
+## Jump to a module
+
+Press **G**, then a letter, within about a second and a half. The sidebar shows each module's letter when you hover it.
+
+| Keys | Module | Keys | Module |
+| --- | --- | --- | --- |
+| G then A | Accounting | G then Q | Quality |
+| G then D | Documents | G then U | Resources |
+| G then I | Inventory | G then S | Sales |
+| G then V | Invoicing | G then E | Settings |
+| G then T | Items | G then Y | Users |
+| G then O | People | G then W | Workflows |
+| G then R | Production | G then P | Purchasing |
+
+Items, Invoicing, and Inventory all start with I, so Items is **T** and Invoicing is **V**. A shortcut only works for a module you can see in your sidebar: one you have hidden, or have no permission for, does nothing.
+
+## Move through tables
+
+On any paged table, **←** goes to the previous page and **→** to the next. The Previous and Next buttons show the key when you hover them. **N** opens a new record from a list page, and **⌘K** (Ctrl+K on Windows) opens search from anywhere.
+
+## Act from a menu
+
+When a three-dot menu or a right-click menu is open, one key runs an item. The key is shown on the right of the item.
+
+| Key | Action |
+| --- | --- |
+| E | Edit |
+| R | Rename |
+| P | Pin or unpin |
+| C | Duplicate or copy |
+| D | Download |
+| O | View or open |
+
+The menu closes and the action runs, exactly as if you had clicked it. These keys work only while that menu is open. Pressing E on the page behind it does nothing.
+
+Removing data is never one keystroke away. Delete items in a menu show no key; choose them with the mouse, or with the arrow keys and Enter.
+
+A letter no item uses still jumps to the first item starting with it, so you can reach the rest with the arrow keys. The same menu keys work in the shop-floor app.
+
+ - Workflows Automations and their run history.
+ - Company settings Where company-wide options live.
+
+Internals: shared menu keys are `MENU_ITEM_SHORTCUTS` in `packages/react/src/shortcuts.ts` (edit e, rename r, pin p, duplicate/copy c, download d, view/open o; no delete key). A menu item opts in with `shortcut={MENU_ITEM_SHORTCUTS.x}` on `DropdownMenuItem`, `ContextMenuItem`, or `MenuItem`. The handler (`packages/react/src/utils/menuShortcut.ts`) sits on the menu content's `onKeyDown`, so keys only work while that menu is open; letters match the physical key, so non-Latin layouts work; any modifier opts out.
+
+Module jumps: `MODULE_GO_TO` in `apps/erp/app/shortcuts.ts`, run by `useShortcutSequence` (1.5 s window, ignored while typing, while a dialog is open, and while the sidebar is being customized). Shop Floor has no letter because it opens the separate shop-floor app.
+
+"I pressed a letter in a menu and nothing happened": that menu item has no key (only Edit, Rename, Pin, Duplicate/Copy, Download, View/Open have one), or focus is inside a text field in the menu. "G then a letter does nothing": the module is hidden from the user's sidebar or they lack view permission for it, or more than 1.5 s passed between the keys.
diff --git a/apps/erp/app/modules/agent/kb/docs/reference/workflows.md b/apps/erp/app/modules/agent/kb/docs/reference/workflows.md
index df9df619aa..1caf4e3950 100644
--- a/apps/erp/app/modules/agent/kb/docs/reference/workflows.md
+++ b/apps/erp/app/modules/agent/kb/docs/reference/workflows.md
@@ -76,7 +76,7 @@ Every step reads and writes with the owner's permissions, re-checked at each ste
## Runs and history
-Every firing is recorded as a workflow run: one row for the run and one per step, with the values in, the values out, and why it ended the way it did. Open **Automate → Runs** for the list: status, workflow, trigger, the record it started from, duration, owner, and a **Chain** cell reading **"Hop 2"** when the run was caused by another run. Rows update live while anything is queued or running.
+Every firing is recorded as a workflow run: one row for the run and one per step, with the values in, the values out, and why it ended the way it did. Open **Automate → Runs** for the list: status, workflow, trigger, the record it started from (shown by its name or number, and linked so you can open it), duration, owner, and a **Chain** cell reading **"Hop 2"** when the run was caused by another run. Rows update live while anything is queued or running.
- **Queued**: Accepted and waiting for a worker to pick it up.
- **Running**: A worker has claimed it and is walking the steps.
diff --git a/apps/erp/app/modules/agent/kb/manifest.json b/apps/erp/app/modules/agent/kb/manifest.json
index b4cc52d6da..b6495311cd 100644
--- a/apps/erp/app/modules/agent/kb/manifest.json
+++ b/apps/erp/app/modules/agent/kb/manifest.json
@@ -946,6 +946,13 @@
"The list view shows no Start / Complete affordances"
]
},
+ {
+ "slug": "docs/reference/keyboard-shortcuts",
+ "title": "Keyboard shortcuts",
+ "description": "Jump between modules, page through tables, and run menu actions from the keyboard, with the full list one keypress away.",
+ "keywords": ["keyboard", "shortcuts", "docs", "reference"],
+ "headings": ["Jump to a module", "Move through tables", "Act from a menu"]
+ },
{
"slug": "docs/reference/maintenance",
"title": "Maintenance",
diff --git a/docs/app/docs/layout.tsx b/docs/app/docs/layout.tsx
index 25425bb0c2..04671eee3a 100644
--- a/docs/app/docs/layout.tsx
+++ b/docs/app/docs/layout.tsx
@@ -44,7 +44,7 @@ function toNav(nodes: TreeNode[]): DocsNavNode[] {
// URLs (/docs/reference/<slug>) never move. Any reference page missing from this map is
// appended ungrouped, so adding a new entity can never make it vanish from the nav.
const REFERENCE_GROUPS: { label: string; slugs: string[] }[] = [
- { label: "Getting started", slugs: ["onboarding"] },
+ { label: "Getting started", slugs: ["onboarding", "keyboard-shortcuts"] },
{
label: "Sales",
slugs: ["quotes", "pricing", "sales-orders", "rmas", "customer-portal"],
diff --git a/docs/content/docs/reference/keyboard-shortcuts.mdx b/docs/content/docs/reference/keyboard-shortcuts.mdx
new file mode 100644
index 0000000000..5b4cf17624
--- /dev/null
+++ b/docs/content/docs/reference/keyboard-shortcuts.mdx
@@ -0,0 +1,62 @@
+---
+title: Keyboard shortcuts
+description: Jump between modules, page through tables, and run menu actions from the keyboard, with the full list one keypress away.
+---
+
+Most of what you do with the mouse in Carbon has a key. Press **?** on any page to open the full list. Shortcuts are ignored while you type in a field, so they never interrupt a form.
+
+<Screenshot label="The Keyboard shortcuts list opened with ?, showing the General, Go to module, and In an open menu groups" caption="The in-app list is always current for your screen." />
+
+## Jump to a module
+
+Press **G**, then a letter, within about a second and a half. The sidebar shows each module's letter when you hover it.
+
+| Keys | Module | Keys | Module |
+| --- | --- | --- | --- |
+| G then A | Accounting | G then Q | Quality |
+| G then D | Documents | G then U | Resources |
+| G then I | Inventory | G then S | Sales |
+| G then V | Invoicing | G then E | Settings |
+| G then T | Items | G then Y | Users |
+| G then O | People | G then W | Workflows |
+| G then R | Production | G then P | Purchasing |
+
+Items, Invoicing, and Inventory all start with I, so Items is **T** and Invoicing is **V**. A shortcut only works for a module you can see in your sidebar: one you have hidden, or have no permission for, does nothing.
+
+## Move through tables
+
+On any paged table, **←** goes to the previous page and **→** to the next. The Previous and Next buttons show the key when you hover them. **N** opens a new record from a list page, and **⌘K** (Ctrl+K on Windows) opens search from anywhere.
+
+## Act from a menu
+
+When a three-dot menu or a right-click menu is open, one key runs an item. The key is shown on the right of the item.
+
+| Key | Action |
+| --- | --- |
+| E | Edit |
+| R | Rename |
+| P | Pin or unpin |
+| C | Duplicate or copy |
+| D | Download |
+| O | View or open |
+
+The menu closes and the action runs, exactly as if you had clicked it. These keys work only while that menu is open. Pressing E on the page behind it does nothing.
+
+<Callout type="note" title="Delete has no key">
+Removing data is never one keystroke away. Delete items in a menu show no key; choose them with the mouse, or with the arrow keys and Enter.
+</Callout>
+
+A letter no item uses still jumps to the first item starting with it, so you can reach the rest with the arrow keys. The same menu keys work in the shop-floor app.
+
+<Cards>
+ <Card title="Workflows" href="/docs/reference/workflows">Automations and their run history.</Card>
+ <Card title="Company settings" href="/docs/reference/company-settings">Where company-wide options live.</Card>
+</Cards>
+
+<AgentContext>
+Internals: shared menu keys are `MENU_ITEM_SHORTCUTS` in `packages/react/src/shortcuts.ts` (edit e, rename r, pin p, duplicate/copy c, download d, view/open o; no delete key). A menu item opts in with `shortcut={MENU_ITEM_SHORTCUTS.x}` on `DropdownMenuItem`, `ContextMenuItem`, or `MenuItem`. The handler (`packages/react/src/utils/menuShortcut.ts`) sits on the menu content's `onKeyDown`, so keys only work while that menu is open; letters match the physical key, so non-Latin layouts work; any modifier opts out.
+
+Module jumps: `MODULE_GO_TO` in `apps/erp/app/shortcuts.ts`, run by `useShortcutSequence` (1.5 s window, ignored while typing, while a dialog is open, and while the sidebar is being customized). Shop Floor has no letter because it opens the separate shop-floor app.
+
+"I pressed a letter in a menu and nothing happened": that menu item has no key (only Edit, Rename, Pin, Duplicate/Copy, Download, View/Open have one), or focus is inside a text field in the menu. "G then a letter does nothing": the module is hidden from the user's sidebar or they lack view permission for it, or more than 1.5 s passed between the keys.
+</AgentContext>
diff --git a/docs/content/docs/reference/meta.json b/docs/content/docs/reference/meta.json
index e296de2c01..9ca8ad7c4e 100644
--- a/docs/content/docs/reference/meta.json
+++ b/docs/content/docs/reference/meta.json
@@ -67,6 +67,7 @@
"single-sign-on",
"account",
"onboarding",
+ "keyboard-shortcuts",
"sharing",
"agent",
"workflows",
diff --git a/docs/content/docs/reference/workflows.mdx b/docs/content/docs/reference/workflows.mdx
index e922e94411..a703bb628a 100644
--- a/docs/content/docs/reference/workflows.mdx
+++ b/docs/content/docs/reference/workflows.mdx
@@ -92,7 +92,7 @@ Every step reads and writes with the owner's permissions, re-checked at each ste
## Runs and history
-Every firing is recorded as a <Term>workflow run</Term>: one row for the run and one per step, with the values in, the values out, and why it ended the way it did. Open **Automate → Runs** for the list: status, workflow, trigger, the record it started from, duration, owner, and a **Chain** cell reading **"Hop 2"** when the run was caused by another run. Rows update live while anything is queued or running.
+Every firing is recorded as a <Term>workflow run</Term>: one row for the run and one per step, with the values in, the values out, and why it ended the way it did. Open **Automate → Runs** for the list: status, workflow, trigger, the record it started from (shown by its name or number, and linked so you can open it), duration, owner, and a **Chain** cell reading **"Hop 2"** when the run was caused by another run. Rows update live while anything is queued or running.
<Screenshot label="The Run Details drawer from Automate → Runs: outcome sentence, step list in workflow order with a skipped branch greyed out, and one step expanded showing Input and Output" caption="The outcome sentence is the fastest way to understand a run." />