RabbinatixDocs
Sign inGet started

Getting started

Navigating the app

The sidebar, search and the command palette, page help and Simple view, action menus, notifications, the theme and keyboard shortcuts.

Open Dashboard in the app

The layout

Every page in the app has the same frame:

  • the sidebar on the left, with the organization menu at the top, search and New beside it, the main sections, Docs and your account menu at the bottom;
  • the header along the top, with the page title, page help, the environment and the notifications bell. In an editor (logic, a flow, a whiteboard, a page) the editor's own bar names what is open, so the header shows no title;
  • the page itself.

Click the panel icon at the left of the header (Collapse sidebar) to shrink the sidebar to icons. On a narrow screen it is icons until you open it. Click a group's heading (Overview, Team, Delivery, …) to fold its items away; a folded group still shows how many things wait for you, and the group of the page you are on always stays open. Right-click a heading, or search the command palette, for Fold all and Unfold all. This device remembers what you folded. Some pages, such as a flow, have a focus mode that hides the sidebar and header; press Esc to leave it.

The sidebar sections

SectionPages
OverviewDashboard, System map, Systems, API catalog, What’s linked
BehaviourWhiteboards, Flows, Logic, Test data, Expected results, Requirements
TeamChat, Board, Pages
CalendarCalendar, Meetings, Time away, World clock
DeliveryChanges, Releases, Deployments, Environments
ChecksSecurity checks, Code impact, Retiring APIs
NetworkPublic APIs
OrganizationIntegrations, Activity, Settings

New, beside search, makes a Ticket, a System, Logic or a Whiteboard, and has Import, Connect systems and From the Store. It offers only what your role may do, and nothing that changes the design while another environment than Development is picked.

Hover over an item to see what it is for. A number next to an item needs your attention: red counts are broken contracts, failing flows or unread chat; grey counts are tickets assigned to you or drafts waiting for review. Changes appears when your organization reviews changes before they are published, when you have changes waiting, or once your AI assistant has sent drafts (its From your AI assistant view). See Your AI assistant.

Search and the command palette

Click Search… in the sidebar, or press Ctrl+K (⌘K on a Mac), from any page.

Type to find:

  • systems, APIs by path or summary, flows, whiteboards, tickets, written pages, chat channels, store packages, public APIs, releases and deployments;
  • any key, such as FLOW-AUTH-LOGIN-001;
  • pages, by name, such as Board, Import, Integrations, Activity, Changes or AI drafts;
  • actions, such as New system, Connect systems, New ticket, New whiteboard or turning Simple view on and off.

A name typed in full comes first, then a name that starts with what you typed.

Type broken to list every broken contract. Ask a question such as who depends on payments?, what does web app call?, where is line total used? or which flows have no test cases? and the palette answers from your map. The top result that is an object also gets a What’s linked item that shows everything linked to it.

Use ↑ and ↓ to move, Enter to open and Esc to close.

Page help and Simple view

Next to each page title is a help button (a question mark). It explains what the page is for, what you can do there and the words it uses. Its How to use … link opens the page's full guide in a new tab, and All terms, explained in the docs opens the glossary.

Simple view is for people who don't write code. It uses plain words and hides technical IDs. On a system's page, an endpoint that has a name shows just its name, without its method and path:

NormalSimple view
API catalogAPIs
FlowsBusiness flows
RequirementsBusiness rules
DeploymentsReleases

Turn it on from the account menu at the top right, from Switch to Simple view in the page help, from the command palette, or in Settings → Appearance. It is remembered in this browser. To turn it off, use the same switch or Show technical details.

Action menus

Page headers show the main action and a few frequent ones as buttons. Everything else is in the More actions menu (⋯). When the window gets narrower, buttons move into that menu instead of crowding the title, so if you can't see an action, look there.

The menu works with the keyboard: Enter, Space or ↓ opens it, the arrow keys move, typing a letter jumps to an item, and Esc closes it. Actions that delete something are always last in the menu and ask before they run.

Most More menus end with How to use …, which opens the guide to everything that page can do, next to Take the 1-minute tour where a page has one.

Notifications

The bell in the header shows how many notifications you haven't read. Click it to see the latest ones; click one to go to what it is about. Use Mark all read to clear the count, or View all notifications for the full list. See Notifications.

Your account menu

Click your name at the top right for:

  • Simple view and Theme (Light, Dark or System, which follows your device);
  • My tickets, the board filtered to tickets assigned to you;
  • Request access, to ask for more permissions in an organization;
  • Sign out.

Keyboard shortcuts

KeysWhereWhat
Ctrl+K / ⌘KEverywhereOpen or close the command palette
Ctrl+. / ⌘.EverywhereOpen or close the chat list (the chat button in the lower right corner)
F6EverywhereMove between the page and the open chat windows
EscA chat windowMinimize it
EscEverywhereClose the top menu or dialog, then leave focus mode
?Board, logic editor, chatShow that page's shortcuts
j / kBoardNext or previous ticket
cBoardNew ticket
/BoardSearch and filter

Each page with shortcuts also lists them under Keyboard shortcuts. On a Mac, use ⌘ for Ctrl.

Single letters such as j, k, c and / can be turned off. Open Settings → Appearance and switch off Single-key shortcuts. Do this if you use speech input or type them by accident. Shortcuts with Ctrl or ⌘ stay on. See Accessibility.

The dashboard

The Dashboard opens when you enter an organization or project. It shows contract health across your systems, with counts you can click, and sections such as Critical flows, My tickets, Contract health, last 30 days, Needs attention, Upcoming shutdowns and Recent activity. Open system map takes you to the map.

A new organization or project with no systems shows the Start building your system card instead. It has two ways in:

  1. Go to the system map to add your own systems. The quick start walks through it.
  2. Or start from a ready-made system map to preview ready-made systems and the APIs between them, then copy them in.

The card goes away once you add a system. You can also close it with its X.