Skip to content

docs: add missing links and clean up#1370

Merged
samsja merged 5 commits intofeat-rewrite-v2from
docs-clean-up
Apr 14, 2023
Merged

docs: add missing links and clean up#1370
samsja merged 5 commits intofeat-rewrite-v2from
docs-clean-up

Conversation

@anna-charlotte
Copy link
Copy Markdown
Contributor

Goals:

Added some missing links in the docs, fixxed some docstring renderings, clean up a bit

  • check and update documentation, if required. See guide

Signed-off-by: anna-charlotte <[email protected]>
anna-charlotte added 4 commits April 14, 2023 08:45
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
@github-actions
Copy link
Copy Markdown

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

@anna-charlotte anna-charlotte marked this pull request as ready for review April 14, 2023 07:08
@anna-charlotte anna-charlotte requested a review from samsja April 14, 2023 07:08
@samsja samsja merged commit 6c45d4b into feat-rewrite-v2 Apr 14, 2023
@samsja samsja deleted the docs-clean-up branch April 14, 2023 07:09
anna-charlotte pushed a commit that referenced this pull request Apr 14, 2023
* docs: add links and clean up

Signed-off-by: anna-charlotte <[email protected]>

* fix: Text to TextDoc

Signed-off-by: anna-charlotte <[email protected]>

* fix: 3d urls

Signed-off-by: anna-charlotte <[email protected]>

* fix: pc url

Signed-off-by: anna-charlotte <[email protected]>

* fix: comment out display pc

Signed-off-by: anna-charlotte <[email protected]>

---------

Signed-off-by: anna-charlotte <[email protected]>
anna-charlotte pushed a commit that referenced this pull request Apr 14, 2023
* docs: add storing with file

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* docs: add docs for the S3 store

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* docs: add docs for jac store

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* docs: store section in user guide

Signed-off-by: anna-charlotte <[email protected]>

* docs: add doc stores to api reference section

Signed-off-by: anna-charlotte <[email protected]>

* docs: fix docstrings

Signed-off-by: anna-charlotte <[email protected]>

* fix: clean up

Signed-off-by: anna-charlotte <[email protected]>

* fix: path in file doc store

Signed-off-by: anna-charlotte <[email protected]>

* docs(menu): consistency, wording fixes (#1363)

* docs(menu): consistency, wording fixes

Signed-off-by: Alex C-G <[email protected]>

* docs(intro): remove redundancy in title

Signed-off-by: Alex C-G <[email protected]>

---------

Signed-off-by: Alex C-G <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* fix: default dims=-1 for elastic index (#1368)

Signed-off-by: AnneY <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* fix: s3 bucket var

Signed-off-by: anna-charlotte <[email protected]>

* fix: typo and s3 delete code snippet

Signed-off-by: anna-charlotte <[email protected]>

* docs: exclude jacdocstore docs from test for now

Signed-off-by: anna-charlotte <[email protected]>

* Revert "docs: exclude jacdocstore docs from test for now"

This reverts commit a52fed5.

Signed-off-by: anna-charlotte <[email protected]>

* docs: exclude jac tests

Signed-off-by: anna-charlotte <[email protected]>

* feat: weaviate document index V2! (#1367)

Signed-off-by: anna-charlotte <[email protected]>

* docs: add sending section (#1350)

* docs: add serialization for json

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for binary and protobuf

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for base64 and bytes

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for csv

Signed-off-by: nan-wang <[email protected]>

* docs: add serialization for dataframe

Signed-off-by: nan-wang <[email protected]>

* fix: add doctring to documentaion basedoc

Signed-off-by: samsja <[email protected]>

* fix: fix mypy

Signed-off-by: samsja <[email protected]>

* fix: add docstring doc list

Signed-off-by: samsja <[email protected]>

* fix: dic doc array docstring

Signed-off-by: samsja <[email protected]>

* fix: fix page for doc list serilizaiton

Signed-off-by: samsja <[email protected]>

* fix: fix docstring

Signed-off-by: samsja <[email protected]>

* feat: add docvec

Signed-off-by: samsja <[email protected]>

* docs: add send doc section

Signed-off-by: samsja <[email protected]>

* docs: fix docstring

Signed-off-by: samsja <[email protected]>

* refactor: better tree structure for sending

Signed-off-by: samsja <[email protected]>

* fix: fix tests

Signed-off-by: samsja <[email protected]>

* fix: fix python code snippet ods

Signed-off-by: samsja <[email protected]>

* fix: fix remove breakpoint

Signed-off-by: samsja <[email protected]>

* feat: add intro

Signed-off-by: samsja <[email protected]>

* feat: add ref

Signed-off-by: samsja <[email protected]>

* feat: move fastapi part

Signed-off-by: samsja <[email protected]>

* fix: fix fastAPI

Signed-off-by: samsja <[email protected]>

* fix: remove uselss mixin

Signed-off-by: samsja <[email protected]>

* faet: add jina section

Signed-off-by: samsja <[email protected]>

* fix: compress -> compression

Signed-off-by: samsja <[email protected]>

* feat: apply suggestion

Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Co-authored-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: samsja <[email protected]>

* fix: apply alex suggestion

Signed-off-by: samsja <[email protected]>

* wip

Signed-off-by: samsja <[email protected]>

* fix: fix all docstring

Signed-off-by: samsja <[email protected]>

* fix: fix update docstring

Signed-off-by: samsja <[email protected]>

* fix: fix ruff

Signed-off-by: samsja <[email protected]>

* fix: fix smth

Signed-off-by: samsja <[email protected]>

* feat: apply charllote suggestion

Co-authored-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: samsja <[email protected]>

---------

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
Co-authored-by: samsja <[email protected]>
Co-authored-by: samsja <[email protected]>
Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Co-authored-by: Charlotte Gerhaher <[email protected]>

* fix: apply sami suggestion

Co-authored-by: samsja <[email protected]>
Signed-off-by: Charlotte Gerhaher <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>

* fix: apply suggestions from samis code review

Signed-off-by: anna-charlotte <[email protected]>

* docs: add missing links and clean up (#1370)

* docs: add links and clean up

Signed-off-by: anna-charlotte <[email protected]>

* fix: Text to TextDoc

Signed-off-by: anna-charlotte <[email protected]>

* fix: 3d urls

Signed-off-by: anna-charlotte <[email protected]>

* fix: pc url

Signed-off-by: anna-charlotte <[email protected]>

* fix: comment out display pc

Signed-off-by: anna-charlotte <[email protected]>

---------

Signed-off-by: anna-charlotte <[email protected]>

---------

Signed-off-by: nan-wang <[email protected]>
Signed-off-by: anna-charlotte <[email protected]>
Signed-off-by: Alex C-G <[email protected]>
Signed-off-by: AnneY <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: samsja <[email protected]>
Signed-off-by: Charlotte Gerhaher <[email protected]>
Co-authored-by: anna-charlotte <[email protected]>
Co-authored-by: Alex Cureton-Griffiths <[email protected]>
Co-authored-by: Anne Yang <[email protected]>
Co-authored-by: Shukri <[email protected]>
Co-authored-by: samsja <[email protected]>
Co-authored-by: samsja <[email protected]>
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.

2 participants