Skip to content

Enhancement: Display description for all input fields #441

@michaeltlombardi

Description

@michaeltlombardi

Is your feature request related to a problem? Please describe.

The improvement in #391 made it much easier to understand metadata, but I noticed that the improved behavior didn't land for editing data files from the dashboard or inserting snippets. In both cases, the description key appears unused, neither appearing in the view nor when hovering over the inputs or their labels.

Describe the solution you'd like

I would like for the description key, when defined for input fields, to display in the same context similarly to how it does for content metadata fields. This would make it easier to understand what the inputs are for without having to refer to documentation.

Describe alternatives you've considered

Alternative to always displaying the description text, displaying that text when the user hovers on the label for that input would also be useful and possibly less disruptive to the UX, though also less discoverable I think.

Additional context

Screenshot of a snippet modal beside its definition, showing the use of the description key but no indication in the modal of what the inputs do.

Screenshot of editing a data file in the dashboard beside the data type's definition, showing the use of the description key but no indication in the dashboard of what the inputs do.

Metadata

Metadata

Assignees

No one assigned

    Labels

    In BETAThe current task is available for testing in the BETA version.enhancementNew feature or requestv10.2.0Project: v10.2.0v10.3.0Project: v10.3.0

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions