adam/vscode-front-matter
1
0 Fork 0
mirror of https://github.com/estruyf/vscode-front-matter.git synced 2026-11-03 09:02:19 +01:00
Code Issues 77 Packages Projects Releases Wiki Activity

Enhancement: Display description for all input fields #356

New Issue
Closed
opened 2026-10-05 02:42:36 +02:00 by adam · 1 comment
adam commented 2026-10-05 02:42:36 +02:00
Owner
Copy link
Copy source

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.

**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.](https://user-images.githubusercontent.com/14190564/194686867-d0d85587-9437-4a02-b198-b1025d06793c.png) ![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.](https://user-images.githubusercontent.com/14190564/194687037-88179aff-05c5-43bf-9257-628b8d593c0a.png) <!-- github-sync-id:1401812033 -->
adam closed this issue 2026-10-05 02:42:36 +02:00
adam commented 2026-10-05 02:42:37 +02:00
Author
Owner
Copy link
Copy source

Input descriptions should now appear on snippet forms and data forms in the latest beta version.

Input descriptions should now appear on snippet forms and data forms in the latest beta version. <!-- github-comment-id:2126690184 -->
Sign in to join this conversation.
No Branch/Tag Specified
Labels
No items
No labels
Milestone
No items
No Milestone
Projects
Clear projects
No projects
Assignees
Clear assignees
adam (Adam Wojcieszonek)
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: adam/vscode-front-matter#356