diff --git a/doc/README.md b/doc/README.md index 40ea3cd0ca709143e3fdda20417b86adc96a7399..1b3d90244cca9b6cc32e1c0ecf7027637652e90a 100644 --- a/doc/README.md +++ b/doc/README.md @@ -14,7 +14,7 @@ It aims to be a complete solution including features like: ## About this Documentation -Documentation is structured in two parts: User documentation and Development documentation. If you just want to use the software, the former is for you. +Documentation is structured in two parts: User documentation and Development documentation. If you just want to use the software, [the former](./user/index.md) is for you. Furthermore, we acknowledge divio's [documentation system](https://docs.divio.com/documentation-system/), consisting of: * learning oriented **tutorials â—†**, * problem oriented **how-to guides â—‡**, diff --git a/doc/user/howto_basic.md b/doc/user/howto_basic.md index bde5e129b81fa04846089cc1429fe318423b4a81..9c0c8e365e6b0bd619236ec792beacbb2d8d3846 100644 --- a/doc/user/howto_basic.md +++ b/doc/user/howto_basic.md @@ -7,4 +7,21 @@ SPDX-License-Identifier: AGPL-3.0-only This how-to helps you set up Suggestible using your own data. If you want to just try out Suggestible with some sample data at first, we recommend to try the [introductory tutorial](tutorial_basic.md) first. -If you don't have a compiled version of Suggestible yet, follow our [build how-to](howto_build.md). \ No newline at end of file +If you don't have a compiled version of Suggestible yet, follow our [build how-to](howto_build.md). +## Place Training Data +To use Suggestible, you need a csv file named `data.csv` with training data to learn suggestions from. Suggestible is looking for it in whichever folder you are running Suggestible from. +Currently, Suggestible needs the sixth column of the csv to contain the actual search queries. This is subject to change. + +Here is an example of what your file could look like: +```csv +"time","referer","request_time","focus","locale","query" +2024-04-01 08:35:42.000 +0200,,,web,en,what is love? +``` + +## Configuring Suggestible +Currently, no configuration is possible. This will change soon. + +## Running Suggestible +When you run Suggestible it will look for a data.csv in your current working directory, read it and then start a web server on port 80. + +It exposes an [OpenSearch](https://github.com/dewitt/opensearch/blob/master/mediawiki/Specifications/OpenSearch/Extensions/Suggestions/1.1/Draft%201.wiki) compliant suggestions api at `/?q={searchTerms}`. \ No newline at end of file