Skip to content

chore(docs): Add an Async Explainer doc #200

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

dishaprakash
Copy link
Collaborator

chore(docs): Add an Async Explainer doc

This async explainer doc explains the benefits of a having duality in classes for PGVectorStore.

@dishaprakash dishaprakash marked this pull request as draft April 14, 2025 10:19
@averikitsch
Copy link
Collaborator

@eyurtsev what are your thoughts on adding this as a GitHub wiki for this repo?

@eyurtsev
Copy link
Collaborator

@eyurtsev what are your thoughts on adding this as a GitHub wiki for this repo?

We tend to use mkdocs since it's visually more appealing, but it has slightly higher overhead, so entirely up to you!

@dishaprakash dishaprakash marked this pull request as ready for review April 17, 2025 21:24
@averikitsch
Copy link
Collaborator

@eyurtsev what are your thoughts on adding this as a GitHub wiki for this repo?

We tend to use mkdocs since it's visually more appealing, but it has slightly higher overhead, so entirely up to you!

@eyurtsev Do you have any concerns with having this doc in the root of the repo or would you like us to create a docs/ directory?

@eyurtsev
Copy link
Collaborator

Docs folder is better

@dishaprakash dishaprakash requested a review from eyurtsev April 22, 2025 18:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants