-
Notifications
You must be signed in to change notification settings - Fork 7
Add Developer guide #46
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks, I have some comments on typos and formatting. In addition to these comments, please try to be consistent with how you end the sentences that come right before code blocks. In k-NN
, you can see how most either end with a period or a colon, like "To do X, run:" or "add the
@Profile annotation."
f7d56e7
to
74fd126
Compare
Signed-off-by: Rajvaibhav Rahane <[email protected]>
Some small comments left from me - I plan on adding the API image docs to this guide afterwards, so I can make these changes in a follow up PR. |
Two small comments, otherwise looks good to me |
Signed-off-by: Rajvaibhav Rahane <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should be my final nits, thank you!
Signed-off-by: Rajvaibhav Rahane <[email protected]>
…r-index-builder into dev-guide Signed-off-by: Rajvaibhav Rahane <[email protected]>
Signed-off-by: Rajvaibhav Rahane <[email protected]>
Description
Add Developer Guide
https://github.com/Rajrahane/remote-vector-index-builder/blob/dev-guide/DEVELOPER_GUIDE.md
Visual Representation
Issues Resolved
Partly solves #2
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.