vitrivr/vitrivr-engine

Minimal documentation

Closed this issue · 2 comments

Minimal documentation must be prepared. This includes:

  • Basic setup
  • Using vitrivr-engine as dependency
  • Creating vitrivr-engine plugins
  • Configuration Extraction Pipeline including a minimal example.
  • Configuration Query Pipeline including minimal examples (NNS, Boolean, etc.)
  • List of existing operators including a brief description
  • List of existing descriptors / features including a brief description
  • Example

Updated with ToDo's - please add your input if you think important topics are missing@

The wiki has been set-up. There is a small part regarding query pipelines still missing (e.g. a real-world example), which will be added soon.

Ideally, now that the documentation is here in the wiki, there should be an explicit effort to keep it up-to-date.

My part is done here, hence I remove myself from the list of assignees.