Skip to content

Dashboard override

A Dashboard override replaces part of a derived Dashboard; without one, every scope's Dashboard compiles from its records.

PropertyValue
Pathdashboards/[dashboard].mdx
HoldsDashboard
Kindfile
Leadersdb-first, git-first
TeamOperations Team
Written byChange.merge
Compiled byStartupBuilder

Example

dashboards/close.mdx in a Startup repository. Closewise, a sample business, declares a Close Noun.

dashboards/close.mdx
---
scope: finance/controller
title: Month-end close
---
<MetricTile metric="days-to-close" window="month" />
<DataTable noun="Close" where="balanced = false" sort="period" />
<TaskInbox role="finance/controller" />
<ApprovalSheet />

Props

The frontmatter keys the file takes. The body is its prose.

PropTypeRequiredDescription
scopestringrequiredWhose Dashboard it is: the Startup, a Team or a Role, by path.
titlestringIts name.

Generates

StartupBuilder compiles it into these records, Verbs and routes.

KindWhat
RecordsDashboard
VerbsDashboard.schedule
RoutesNone.