docs: add user guide#1292
Merged
Merged
Conversation
d6ce907 to
c2909d8
Compare
0fa0798 to
4203355
Compare
4203355 to
1ba2242
Compare
|
This PR exceeds the recommended size of 1000 lines. Please make sure you are NOT addressing multiple issues with one PR. Note this PR might be rejected due to its size. |
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
1ba2242 to
ce37200
Compare
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
JohannesMessner
previously requested changes
Mar 30, 2023
JohannesMessner
left a comment
Member
There was a problem hiding this comment.
Cool! We will have to do loads of polishing work, move stuff around, add or remove sections, but let's not get bogged down too much, I think this is a great starting point!
|
|
||
| class ImageDoc(BaseDoc): | ||
| url: VideoUrl | ||
| bytes: VideoBytes = ( |
Member
Author
There was a problem hiding this comment.
No if you put =None it is optional by default
Member
Author
There was a problem hiding this comment.
do you think it is more explicit to have optional ?
5b6f784 to
3d5b660
Compare
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Co-authored-by: Johannes Messner <44071807+JohannesMessner@users.noreply.github.com> Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>
alexcg1
approved these changes
Mar 31, 2023
Signed-off-by: samsja <sami.jaghouar@hotmail.fr>
Signed-off-by: Alex C-G <alexcg@outlook.com>
jupyterjazz
reviewed
Apr 3, 2023
| * Will perform data validation: `BaseDoc` will check that the data you pass to it is valid. If not, it will raise an | ||
| error. Data being "valid" is actually defined by the type used in the type hint itself, but we will come back to this concept later. (TODO add typing section) | ||
| * Can be configured using a nested `Config` class, see Pydantic [documentation](https://docs.pydantic.dev/usage/model_config/) for more detail on what kind of config pydantic offers. | ||
| * Can be used as a drop-in replacement for `BaseModel` in your code and is compatible with tools that use Pydantic like [FastAPI]('https://fastapi.tiangolo.com/'). |
Contributor
There was a problem hiding this comment.
Just a note to reference FastAPI integration page here that I'm currently working on for whoever merges the second
Co-authored-by: Saba Sturua <45267439+jupyterjazz@users.noreply.github.com> Signed-off-by: samsja <55492238+samsja@users.noreply.github.com>
|
📝 Docs are deployed on https://ft-docs-add-user-guide--jina-docs.netlify.app 🎉 |
seems like he don't want to review :(
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Context
Early PR to merge the beginning of the documentation
https://ft-docs-add-user-guide--jina-docs.netlify.app](https://ft-docs-add-user-guide--jina-docs.netlify.app/