fix(config): add descriptions to JSON schema properties #41
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
rndquu
approved these changes
Dec 4, 2024
| "type": "string" | ||
| }, | ||
| "similarityThreshold": { | ||
| "default": 0.9, | ||
| "description": "When fetching embeddings context, the similarity threshold to use (1- similarityThreshold)", | ||
| "type": "number" |
There was a problem hiding this comment.
Do we want some examples for similarityThreshold and maxTokens? Or do you use that only for the values that have no default?
There was a problem hiding this comment.
My thoughts are:
- If it's obvious and the
inputis filled with the value type (number in this case) then it's pointless and would look silly - If the value is simple and displayed within the description then again no need for a example
These are planned to be displayed above/below the input areas like
When fetching embeddings context...
Examples: [<examples in this array>]
Something like that but within the tooltip. So the user would see how to write this prop 3 different times if we also included examples because it exists in the description and input ele.
This was referenced Dec 4, 2024
Draft
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Relates to ubiquity-os/ubiquity-os-plugin-installer#24