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

Enhancement: Descriptions for schema field definitions in data view #693

New Issue
Closed
opened 2026-10-05 03:00:33 +02:00 by adam · 2 comments
adam commented 2026-10-05 03:00:33 +02:00
Owner
Copy link
Copy source

Is your feature request related to a problem? Please describe.
I am trying to set up some data file schemas. The user is located in the non-developer group. I would like to add a description to fields, in addition to the title, so that I can describe better, what data to enter into the fields.

Describe the solution you'd like

"schema": {
  "title": "Showcases",
  "type": "object",
  "required": [
    "title",
    "description",
    "slug"
  ],
  "properties": {
    "title": {
      "type": "string",
      "title": "Title",
      "description": "a short title of max 24 characters"
    },
    "slug": {
      "type": "string",
      "title": "Slug",
      "description": "a unique string to identify this item"
    },
    "description": {
      "type": "string",
      "multiline": true,
      "title": "Description",
      "description": "A description of this case. Markdown is allowed in this field."
    },
    "byline": {
      "type": "string",
      "multiline": true,
      "title": "Byline"
    }
  }
}

Describe alternatives you've considered
None.

Additional context

image

Design-wise that description could be shown right of the title and required indicator in slightly muted color.

**Is your feature request related to a problem? Please describe.** I am trying to set up some data file schemas. The user is located in the non-developer group. I would like to add a description to fields, in addition to the title, so that I can describe better, what data to enter into the fields. **Describe the solution you'd like** ```json "schema": { "title": "Showcases", "type": "object", "required": [ "title", "description", "slug" ], "properties": { "title": { "type": "string", "title": "Title", "description": "a short title of max 24 characters" }, "slug": { "type": "string", "title": "Slug", "description": "a unique string to identify this item" }, "description": { "type": "string", "multiline": true, "title": "Description", "description": "A description of this case. Markdown is allowed in this field." }, "byline": { "type": "string", "multiline": true, "title": "Byline" } } } ``` **Describe alternatives you've considered** None. **Additional context** ![image](https://github.com/user-attachments/assets/34f4e6e4-3907-4bea-bf82-cafe1f88a402) Design-wise that description could be shown right of the title and required indicator in slightly muted color. <!-- github-sync-id:2615446401 -->
adam closed this issue 2026-10-05 03:00:33 +02:00
adam commented 2026-10-05 03:00:34 +02:00
Author
Owner
Copy link
Copy source

@davidsneighbour, the description should already be shown underneath the input. This is what the dashboard looks like with your provided schema:

image

Which version are you using?

@davidsneighbour, the description should already be shown underneath the input. This is what the dashboard looks like with your provided schema: ![image](https://github.com/user-attachments/assets/c6d94aaa-6bf9-47d2-973f-9bcce0880a45) Which version are you using? <!-- github-comment-id:2441533385 -->
adam commented 2026-10-05 03:00:35 +02:00
Author
Owner
Copy link
Copy source

It works of course 🤣 Sorry, but somehow it didn't came to my mind to look under the field.

It works of course 🤣 Sorry, but somehow it didn't came to my mind to look under the field. <!-- github-comment-id:2442884245 -->
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#693