Skip to content

docs: add DocList and DocVec section#1343

Merged
samsja merged 22 commits intofeat-rewrite-v2from
docs-da
Apr 11, 2023
Merged

docs: add DocList and DocVec section#1343
samsja merged 22 commits intofeat-rewrite-v2from
docs-da

Conversation

@samsja
Copy link
Copy Markdown
Member

@samsja samsja commented Apr 6, 2023

Context

Add array representing section

@samsja samsja changed the title Docs da docs: add DocList and DocVec section Apr 6, 2023
Copy link
Copy Markdown
Member

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the doclist vs docvec section can be made a bit clearer, but let's get this out there and iterate late. We're short on time ^^

Also, i would minimize the pydantic references a bit. They aren't really needed and might turn away people that aren't arleady familiar with it

Copy link
Copy Markdown
Member

@JohannesMessner JohannesMessner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the doclist vs docvec section can be made a bit clearer, but let's get this out there and iterate late. We're short on time ^^

Also, i would minimize the pydantic references a bit. They aren't really needed and might turn away people that aren't arleady familiar with it

Signed-off-by: samsja <[email protected]>
@github-actions github-actions bot added size/l and removed size/m labels Apr 6, 2023
samsja and others added 9 commits April 6, 2023 14:55
Co-authored-by: Johannes Messner <[email protected]>
Signed-off-by: samsja <[email protected]>
Co-authored-by: Johannes Messner <[email protected]>
Signed-off-by: samsja <[email protected]>
Co-authored-by: Johannes Messner <[email protected]>
Signed-off-by: samsja <[email protected]>
Co-authored-by: Johannes Messner <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
@alexcg1
Copy link
Copy Markdown
Contributor

alexcg1 commented Apr 6, 2023

I'll do my usual thing on this PR. Namely, make my changes on the branch after everything else has been resolved. So I won't be jumping and making suggestions just yet

Signed-off-by: samsja <[email protected]>
@samsja
Copy link
Copy Markdown
Member Author

samsja commented Apr 11, 2023

@alexcg1 grammarly is applied now you can do your thing

@alexcg1
Copy link
Copy Markdown
Contributor

alexcg1 commented Apr 11, 2023

Will get this done by end of tomorrow, hopefully today. On the road and having some connection issues

@alexcg1
Copy link
Copy Markdown
Contributor

alexcg1 commented Apr 11, 2023

@samsja I'm still seeing big issues that Grammarly should have caught. e.g.

DocArray scope is a edge of different field, from AI to web app. To make it easier to understand, we have created a glossary of terms used in the documentation. 

(e.g. first few words should be DocArray's scope is the edge of a different field. There are many more issues than just this though)

I see you made a commit (5ba6d43) that should have fixed things. It's weird that not everything got fixed.

@samsja samsja marked this pull request as ready for review April 11, 2023 11:33
Signed-off-by: Alex C-G <[email protected]>
Copy link
Copy Markdown
Contributor

@alexcg1 alexcg1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some stuff to clear up


## Concept

### `Multimodal Data`
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Stick to "multimodal" (what we use on jina.ai), not "multi modal" or "multi-modal" (or any other variation)

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

sure thx

@alexcg1
Copy link
Copy Markdown
Contributor

alexcg1 commented Apr 11, 2023

I've pushed my changes and done a review on my push (leaving comments since there are some things I don't understand)

samsja and others added 4 commits April 11, 2023 13:45
Signed-off-by: samsja <[email protected]>
Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Signed-off-by: samsja <[email protected]>
Copy link
Copy Markdown
Contributor

@alexcg1 alexcg1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM 👍

Signed-off-by: samsja <[email protected]>
@github-actions
Copy link
Copy Markdown

📝 Docs are deployed on https://ft-docs-da--jina-docs.netlify.app 🎉

@samsja samsja merged commit 2f71143 into feat-rewrite-v2 Apr 11, 2023
@samsja samsja deleted the docs-da branch April 11, 2023 12:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants