From 8682a1c7e4b7480b5e38ac30bc95abd540a82a06 Mon Sep 17 00:00:00 2001 From: Kristina Spurgin Date: Wed, 28 Feb 2024 15:26:12 -0500 Subject: [PATCH] Clarify record sidebar configuration --- docs/configuration/RecordSidebarConfiguration.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/configuration/RecordSidebarConfiguration.md b/docs/configuration/RecordSidebarConfiguration.md index 000bb18ab..9de6def0d 100644 --- a/docs/configuration/RecordSidebarConfiguration.md +++ b/docs/configuration/RecordSidebarConfiguration.md @@ -4,6 +4,8 @@ The sidebar that is displayed when viewing or editing a record may be configured Currently only the related records that are displayed may be configured, by supplying an array of related record descriptors. A related record panel will be displayed for each descriptor, in the order listed. +**NOTE: This configuration controls the related record *tables* in the sidebar. It does *not* affect/control the media snapshot panel that appears at the top of the sidebar in Object records. See [the `mediaSnapshotSort` setting](./README.md#mediaSnapshotSort) to control order of display in that panel.** + ``` type SidebarDescriptor = { relatedRecords: Array, @@ -49,7 +51,7 @@ A record type name, which must correspond to a key in the [recordTypes](./Record ``` columnSet: string = 'narrow' ``` -A column set name, which must correspond to a key in the [columns](./ColumnConfiguration) configuration for the specified record type. +A column set name, which should correspond to a key in the [columns](./ColumnConfiguration) configuration for the specified record type. If the specified column set does not exist for the specified record type, the `default` columnSet for the record typewill be used. ### sort ```