Skip to content
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

fix(config): add descriptions to JSON schema properties #94

Merged

Conversation

Keyrxng
Copy link
Contributor

@Keyrxng Keyrxng commented Nov 26, 2024

@Keyrxng
Copy link
Contributor Author

Keyrxng commented Nov 27, 2024

@Keyrxng Regarding PRs:

Could you add parameter examples in the parameter descriptions? Otherwise it's really hard for a partner to grasp what exact values the parameters accept.

Sure, and this example should be displayed inside the tooltip as well?? I don't think it'll be effective to use them as "placeholders" for input areas since we fill those with either A) defaults B) their installed config.

@rndquu
Copy link
Member

rndquu commented Nov 27, 2024

Sure, and this example should be displayed inside the tooltip as well??

Yes

I don't think it'll be effective to use them as "placeholders" for input areas since we fill those with either A) defaults B) their installed config.

You mean showing examples in the description is not effective?

@Keyrxng
Copy link
Contributor Author

Keyrxng commented Nov 27, 2024

You mean showing examples in the description is not effective?

No I meant input.placeholder like the background text of input, textarea and things like that.

Sure, and this example should be displayed inside the tooltip as well??

Yes

Yeah no problem

@Keyrxng
Copy link
Contributor Author

Keyrxng commented Nov 27, 2024

Some props don't require an example as they are either:

  • boolean
  • self-explanatory through either it's name, default or description such as emptyWalletText

All have been updated that need an example now

@rndquu
Copy link
Member

rndquu commented Nov 29, 2024

@Keyrxng The examples key is automatically placed in the manifest, correct?

@rndquu rndquu merged commit 973ea32 into ubiquity-os-marketplace:development Dec 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants