Skip to content

Update JSON schema documentation #4934

@wesley-dean

Description

@wesley-dean

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

While working on writing a plugin, I went through the JSON schema looking at each individual field. Some of the fields are a little challenging to track down. For example, the JSON schema mentions linter_icon_png_url and linter_image_url but it's unclear to me which is which.

Describe the solution you'd like

I would like clearer documentation about the purpose of each field, where each field shows up, etc..

Describe alternatives you've considered

It's not really an alternative, but I've taken to using ack to try to track stuff down. It can be a little more time-intensive than having a direct reference, but it's not nothing.

Additional context

I'm happy to do the work. Feel free to assign this to me.

Also, I may reach out with specific questions as I come across them.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions