Skip to content

Update JSON schema documentation #4934

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wesley-dean opened this issue Mar 13, 2025 · 1 comment
Open

Update JSON schema documentation #4934

wesley-dean opened this issue Mar 13, 2025 · 1 comment
Labels
enhancement New feature or request O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity

Comments

@wesley-dean
Copy link
Contributor

wesley-dean commented Mar 13, 2025

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.

Copy link
Contributor

This issue has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this issue should stay open, please remove the O: stale 🤖 label or comment on the issue.

@github-actions github-actions bot added the O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity label Apr 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request O: stale 🤖 This issue or pull request is stale, it will be closed if there is no activity
Projects
None yet
Development

No branches or pull requests

1 participant