Skip to content

capabilities/analytics.mdx describes a joined report as "multi-object", which the ADR-0021 single-form cutover removed #10488

Description

@os-elon

Found while writing content/docs/ui/reports.mdx for #10237 (docs PR #10483). Observation class — capabilities/** is business-language evaluation material rather than authoring documentation, so the bar for editing it is a product-voice decision, not a schema fact. Filed for triage rather than fixed.

The claim

content/docs/capabilities/analytics.mdx, "Reports":

Four shapes — tabular (detail rows), summary (grouped totals), matrix (regions × quarters), and joined (multi-object) — with runtime filters and export. Scheduled email digests deliver a report daily or weekly: the Monday-morning sales report writes itself.

What the schema says

"joined (multi-object)" is no longer true. Under ADR-0021 every block of a joined report is dataset-bound: JoinedReportBlockSchema declares dataset / rows / columns / values / runtimeFilter / order, and the legacy inline objectName + columns + groupings query was removed in the single-form cutover — objectName, object, dataSet and source are alias entries pointing at dataset. The schema's own docblock describes a joined report as "comparative dashboards where each panel is a different slice of the same domain", which is close to the opposite framing. The showcase's TaskOverviewReport is exactly that: two blocks over one dataset, split by runtimeFilter.

Blocks can of course bind different datasets, and those datasets can have different base objects, so "multi-object" is not absurd — but it names the removed mechanism rather than the surviving one, and a reader who takes it literally goes looking for a per-block object key that no longer exists.

Two claims I could not verify either way

Stated as open questions, not as defects:

  • "Scheduled email digests deliver a report daily or weekly."ReportSchema carries no scheduling or delivery key, and I found no report-scheduling surface in packages/services. It could legitimately be delivered by a job or flow plus an email template with no report-side key at all, which would make the sentence true at the capability level. Someone who knows whether that path exists should confirm; if it does not, the sentence is advertising a capability the runtime does not deliver (Prime Directive chore: version packages #10).
  • The HotCRM inventory ("six reports … fed by six shared datasets") was not counted against the example app.

Not fixed here because

The card that found this owns content/docs/ui/** only, and capabilities pages are written in a deliberately different register — a correction should be made by whoever owns that voice, in one pass over the section, rather than as a rider on a UI-docs PR.

Metadata

Metadata

Assignees

Labels

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions