sdslabs / sdslabs/VortexDB

Create docs

Open
#17 0 comments 0 reactions 1 assignee View on GitHub

Nobody has claimed this yet.

documentation priority: high
Dominant language
Rust
Stars
45
Forks
6
Avg merge
2d 20h
Merged PRs (30d)
4

Description

Create docs (or just few markdowns for now in the repo itself) with the following topics in mind

  1. Purpose of the project (About vector-db)
  2. How to run vector-db
  3. How to add your own vectorisers and indexers
  4. Contributing guidelines

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.