chore(docs): Add an Async Explainer doc #200
Merged
Conversation
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
Collaborator
|
@eyurtsev what are your thoughts on adding this as a GitHub wiki for this repo? |
averikitsch
requested changes
Apr 15, 2025
Collaborator
We tend to use mkdocs since it's visually more appealing, but it has slightly higher overhead, so entirely up to you! |
averikitsch
approved these changes
Apr 18, 2025
Collaborator
@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? |
Collaborator
|
Docs folder is better |
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.
chore(docs): Add an Async Explainer doc
This async explainer doc explains the benefits of a having duality in classes for PGVectorStore.