Add examples of using Fields and EnvAuthStrategy to developer documentation #1056
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
dlqqq
requested changes
Oct 29, 2024
There was a problem hiding this comment.
@alanmeeson Thank you for contributing this valuable documentation! Just a minor comment on the formatting below; otherwise this looks great.
This documentation will be online after this PR is merged; no release is required for this change to be made visible.
I have created this example based on some delving into the code and looking at examples of some of the community providers. I haven't included the IntegerField, as I couldn't get it to work properly, suggesting that I don't understand it properly, whereas I have successfully tested the TextField and MultilineTextField.
for more information, see https://pre-commit.ci
As per review feedback, combined the two sections and examples for brevity. Also added a couple of missing imports to the example.
for more information, see https://pre-commit.ci
dlqqq
approved these changes
Oct 31, 2024
There was a problem hiding this comment.
@alanmeeson Great work, thank you! 🎉
Note that we do have example implementations of custom providers & slash commands in packages/jupyter-ai-test on this repo. That may be helpful.
Feel free to open issues or PRs in the future if you encounter more difficulty implementing a custom provider.
|
@meeseeksdev please backport to v3-dev |
meeseeksmachine
pushed a commit
to meeseeksmachine/jupyter-ai
that referenced
this pull request
Oct 31, 2024
…Strategy to developer documentation
dlqqq
pushed a commit
that referenced
this pull request
Oct 31, 2024
…o developer documentation (#1073) Co-authored-by: Alan Meeson <[email protected]>
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.
Based on my (as yet unsuccessful) attempts to add a custom provider, I have captured the bits which I have managed to figure out and get working and added examples of them to the developer docs to help any one looking to add new providers in the future.
I think this could do with a review from someone who understands the Provider design better than I do, to make sure that what I have put is reasonably correct.