Skip to content

Added API documentation #51

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

Merged
merged 3 commits into from
Apr 16, 2025
Merged

Conversation

rchitale7
Copy link
Member

@rchitale7 rchitale7 commented Apr 11, 2025

Description

Adds documentation to the DEVELOPER_GUIDE.md for the API

Also, updated the API.md file with the faiss doc count issue link

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@rchitale7 rchitale7 marked this pull request as ready for review April 11, 2025 23:22
Signed-off-by: Rohan Chitale <[email protected]>
Signed-off-by: Rohan Chitale <[email protected]>
jed326
jed326 previously approved these changes Apr 14, 2025
@Rajrahane
Copy link
Member

Couple of missing end of sentence full stops

Plus feel free to add this link in the description above for Visual Representation for reviewers

https://github.com/rchitale7/remote-vector-index-builder/blob/docs/DEVELOPER_GUIDE.md#provisioning-an-instance-for-development

@navneet1v
Copy link
Collaborator

@Rajrahane , @rchitale7 anything pending on this PR?

Signed-off-by: Rohan Chitale <[email protected]>
@rchitale7
Copy link
Member Author

@navneet1v PR is good now, I made a few changes to make the formatting consistent. Although I need two approvals again

@rchitale7 rchitale7 merged commit 53df058 into opensearch-project:main Apr 16, 2025
3 checks passed
@rchitale7 rchitale7 deleted the docs branch April 16, 2025 16:31
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.

4 participants