Further improvements based on review comments

Author: LinddritAliu

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/cli-commands.md

@@ -29,7 +29,7 @@ testbench-requirement-service [COMMAND] [OPTIONS]
 Create a new configuration file with an interactive wizard.
 
 The wizard guides you through:
-1. Service settings (host, port, debug mode)
+1. Service settings (host, port)
 2. Credential setup (username, password)
 3. Reader selection (JSONL, Excel, Jira, or Custom)
 4. Reader-specific configuration
@@ -143,6 +143,15 @@ testbench-requirement-service start [OPTIONS]
 
 Command-line arguments take **precedence** over configuration file settings.
 
+:::info Built-in reader class names
+When using `--reader-class`, you can specify:
+- `JsonlRequirementReader` — for JSONL files
+- `ExcelRequirementReader` — for Excel/CSV files
+- `JiraRequirementReader` — for Jira API
+
+Or provide a custom reader (e.g. `custom_reader.py` or `custom_reader.CustomClass`).
+:::
+
 ### Examples
 
 ```bash

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/configuration.md

@@ -37,6 +37,7 @@ The following order shows which source takes precedence when the same setting is
 This example uses the JSONL reader. Adjust `reader_class` and `[testbench-requirement-service.reader_config]` for other readers.
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JsonlRequirementReader"
 host = "127.0.0.1"
@@ -99,6 +100,7 @@ The path is resolved relative to the directory where the service is started.
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JsonlRequirementReader"
 reader_config_path = "jsonl_config.toml"
@@ -116,6 +118,7 @@ reader_config_path = "jsonl_config.toml"
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 host = "127.0.0.1"
 port = 8020
@@ -133,6 +136,7 @@ debug = true
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 password_hash = "your_generated_hash"
 salt = "your_generated_salt"
@@ -154,7 +158,7 @@ You will be prompted for a username and password. The command writes `password_h
 Non-interactive mode (e.g. for scripts or CI pipelines — avoid passing `--password` directly in a shared-environment shell to prevent it from being written to shell history):
 
 ```bash
-testbench-requirement-service set-credentials --username ADMIN --password PASSWORD
+testbench-requirement-service set-credentials --username ADMIN_USERNAME --password PASSWORD
 ```
 
 ### HTTPS / TLS
@@ -168,6 +172,7 @@ testbench-requirement-service set-credentials --username ADMIN --password PASSWO
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 ssl_cert = "..."
 ssl_key = "..."
@@ -192,6 +197,7 @@ When using mTLS (`ssl_ca_cert`), the service runs in single-process mode.
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 proxies_count = 1
 real_ip_header = "X-Real-IP"
@@ -235,6 +241,7 @@ server {
 **Service configuration:**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 host = "127.0.0.1"   # bind to localhost only
 port = 8020
@@ -270,6 +277,7 @@ Controls how Sanic spawns and manages its worker process. In most cases you can
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service.server]
 single_process = false
 keep_alive_timeout = 3
@@ -292,6 +300,7 @@ run_kwargs = { workers = 4 }
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service.logging.console]
 log_level = "INFO"
 log_format = "%(asctime)s %(levelname)8s: %(message)s"
@@ -310,6 +319,7 @@ log_format = "%(asctime)s %(levelname)8s: %(message)s"
 **Example:**
 
 ```toml
+# config.toml
 [testbench-requirement-service.logging.file]
 log_level = "INFO"
 log_format = "%(asctime)s - %(levelname)8s - %(name)s - %(message)s"

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/getting-started/installation.md

@@ -54,7 +54,7 @@ Use this option if you have Python installed or are about to install it.
 ### Set up a virtual environment
 
 :::note
-If you are installing [From source](#from-source-developers): create the virtual environment inside the cloned repository instead.
+If you are installing [from source](#from-source-developers): create the virtual environment inside the cloned repository instead.
 :::
 
 A virtual environment keeps the installation isolated and provides a stable, predictable path to the executable. Navigate to the directory where you want the service to live, then run:
@@ -92,7 +92,7 @@ The base install includes the [JSONL reader](../readers/jsonl.md). Add extras fo
 | [Jira](../readers/jira.md) | `pip install testbench-requirement-service[jira]` |
 | All readers | `pip install testbench-requirement-service[excel,jira]` |
 
-Verify:
+Verify installation:
 ```bash
 testbench-requirement-service --version
 ```
@@ -113,7 +113,7 @@ With optional extras:
 pip install "testbench_requirement_service-x.y.z-py3-none-any.whl[excel,jira]"
 ```
 
-Verify:
+Verify installation:
 
 ```bash
 testbench-requirement-service --version
@@ -154,7 +154,7 @@ Install with all readers and development dependencies:
 pip install -e .[excel,jira,dev]
 ```
 
-Verify:
+Verify installation:
 
 ```bash
 testbench-requirement-service --version

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/getting-started/quickstart.md

@@ -18,10 +18,10 @@ testbench-requirement-service init
 ```
 
 This single command walks you through:
-- Service settings (host, port, debug mode)
-- Credentials setup (username, password)
-- Reader selection (JSONL, Excel, Jira, or Custom)
-- Reader-specific configuration
+- [Service settings](../configuration.md#server) (host, port, debug mode)
+- [Credentials setup](../configuration.md#authentication) (username, password)
+- Reader selection ([JSONL](../readers/jsonl.md), [Excel](../readers/excel.md), [Jira](../readers/jira.md), or [Custom](../readers/custom.md))
+- Reader-specific configuration (see the chosen reader's Configuration section)
 
 It creates a complete `config.toml` when finished.
 
@@ -51,11 +51,12 @@ curl -u "ADMIN_USERNAME:PASSWORD" http://127.0.0.1:8020/projects
 
 Choose the extras for your data source. See [Installation](installation.md#from-pypi-online-recommended) for available options.
 
-### 2. Create `config.toml`
+### 2. Create the configuration file
 
-Start from a minimal example. Here is one for the JSONL reader:
+Create a new file called `config.toml` in the root directory of your installation. Start from this minimal example for the JSONL reader:
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JsonlRequirementReader"
 host = "127.0.0.1"

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/readers/custom.md

@@ -29,7 +29,6 @@ Create a Pydantic `BaseModel` for your reader's configuration. The service uses
 
 ```python
 # custom_reader.py
-
 from pydantic import BaseModel
 
 
@@ -45,6 +44,7 @@ If your reader requires no configuration, you can skip this and leave `CONFIG_CL
 Inherit from `AbstractRequirementReader`, set `CONFIG_CLASS`, and implement all abstract methods. Your `__init__` receives an already-validated instance of your config model — you do not need to load or parse any config file yourself:
 
 ```python
+# custom_reader.py
 from testbench_requirement_service.readers.abstract_reader import AbstractRequirementReader
 
 
@@ -111,6 +111,7 @@ Point `reader_class` at your class and add the matching `reader_config` section.
 **Using a file path (recommended for single-file readers):**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "custom_reader.py"
 
@@ -122,6 +123,7 @@ some_option = true
 **Using a module string (recommended for packaged readers):**
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "my_package.my_module.CustomRequirementReader"
 
@@ -133,6 +135,7 @@ some_option = true
 **Using a separate config file** (referenced via `reader_config_path`):
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "custom_reader.py"
 reader_config_path = "custom_reader_config.toml"

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/readers/excel.md

@@ -112,7 +112,7 @@ Can be set globally and overridden per project.
 
 | Setting | Description | Default | Example |
 |---------|-------------|---------|---------|
-| `useExcelDirectly` | `true`: use `.xlsx`/`.xls` files.<br /> `false`: use text files | `false` | `true` |
+| `useExcelDirectly` | `true`: use `.xlsx`/`.xls` files.<br/>`false`: use text files | `false` | `true` |
 | `baselinesFromSubfolders` | Search subfolders for baseline files | `false` | `true` |
 | `worksheetName` | Worksheet name to use in Excel files (falls back to first sheet) | first sheet | `Tabelle1` |
 | `dateFormat` | Date format for version dates. Accepts Java `SimpleDateFormat` (e.g. `yyyy-MM-dd HH:mm:ss`) or Python `strftime` (e.g. `%Y-%m-%d %H:%M:%S`). Auto-detected by presence of `%`. Falls back to `dateutil` auto-detection. | auto | `yyyy-MM-dd HH:mm:ss` |
@@ -196,6 +196,7 @@ For `.properties` files: place a file named `<ProjectName>.properties` inside th
 When configuring inline in `config.toml`, keys containing dots must be **quoted**:
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "ExcelRequirementReader"
 
@@ -212,7 +213,30 @@ useExcelDirectly = false
 "requirement.status" = 5
 ```
 
-### `.properties` file
+### Separate `.toml` file
+
+```toml
+# config.toml
+[testbench-requirement-service]
+reader_class = "ExcelRequirementReader"
+reader_config_path = "excel_config.toml"
+```
+
+```toml
+# excel_config.toml (no section prefix)
+requirementsDataPath = "requirements/excel/"
+columnSeparator = ";"
+arrayValueSeparator = ","
+baselineFileExtensions = ".tsv,.csv,.txt"
+useExcelDirectly = false
+"requirement.id" = 1
+"requirement.version" = 6
+"requirement.name" = 3
+"requirement.owner" = 4
+"requirement.status" = 5
+```
+
+### Separate `.properties` file
 
 ```properties
 # reader_config.properties

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/readers/index.md

@@ -13,7 +13,7 @@ A **reader** is a pluggable component that fetches projects, baselines, and requ
 |--------|------------|-------------------|----------|
 | [**JSONL**](jsonl.md) | `.jsonl` files on disk | None (included in base install) | Simple file-based requirements, CI pipelines, testing |
 | [**Excel**](excel.md) | `.xlsx`, `.xls`, `.csv`, `.tsv`, `.txt` files | `pip install testbench-requirement-service[excel]` | Spreadsheet-based requirement management |
-| [**Jira**](jira.md) | Jira REST API | `pip install testbench-requirement-service[jira]` | Teams managing requirements as Jira issues |
+| [**Jira**](jira.md) | Jira REST API | `pip install testbench-requirement-service[jira]` | Teams managing requirements in Jira as issues |
 
 ## Choosing a reader
 
@@ -33,7 +33,7 @@ The **default reader**, so no extra installation is needed. Use this when:
 Reads from Excel workbooks and delimited text files. Use this when:
 - Your requirements live in `.xlsx`, `.xls`, `.csv`, `.tsv`, or `.txt` files.
 - You need flexible column mapping to match your spreadsheet layout.
-- You want per-project configuration overrides via `.properties` files.
+- You want to be able to override the configuration for a project using `.properties` files.
 
 Supports dataframe buffering for performance with large files.
 
@@ -65,6 +65,7 @@ None of the built-in readers fit? You can create your own by subclassing `Abstra
 Set `reader_class` in your `config.toml` and provide reader-specific settings under `[testbench-requirement-service.reader_config]`:
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JsonlRequirementReader"   # or ExcelRequirementReader, JiraRequirementReader
 
@@ -75,6 +76,7 @@ reader_class = "JsonlRequirementReader"   # or ExcelRequirementReader, JiraRequi
 Alternatively, keep reader settings in a separate file using `reader_config_path`:
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JiraRequirementReader"
 reader_config_path = "jira_config.toml"

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/readers/jira.md

@@ -45,15 +45,18 @@ The Jira account needs the following permissions:
 ### Minimal configuration
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JiraRequirementReader"
 
 [testbench-requirement-service.reader_config]
 server_url = "https://example.atlassian.net/"
 auth_type = "basic"
+username = "my-user@example.com"  # (or set JIRA_USERNAME as environment variable)
+password = "my-api-token"         # (or set JIRA_PASSWORD as environment variable)
 ```
 
-With environment variables for credentials, run in the terminal:
+Set credentials via environment variables, e.g. run in the terminal:
 
 ```bash
 export JIRA_USERNAME=my-user@example.com
@@ -144,7 +147,11 @@ Pick the authentication flow that matches your Jira deployment. Credentials can
 
 ### Project-specific overrides
 
-All requirement and baseline settings can be overridden per project under `[projects.<project>]` (separate config file) or `[testbench-requirement-service.reader_config.projects.<project>]` (inline in config.toml):
+All requirement and baseline settings can be overridden per project.
+
+**Inline in `config.toml`:** Add a `[testbench-requirement-service.reader_config.projects.<project>]` section.
+
+**Separate config file:** Add a `[projects.<project>]` section in your reader config file.
 
 | Setting | Description | Default |
 |---------|-------------|---------|
@@ -162,6 +169,7 @@ All requirement and baseline settings can be overridden per project under `[proj
 ### Inline TOML (recommended)
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JiraRequirementReader"
 

docusaurus/testbench-requirement-service_versioned_docs/version-1.0.0/readers/jsonl.md

@@ -45,6 +45,7 @@ The configuration can be added directly to `config.toml` under `[testbench-requi
 ### Minimal configuration
 
 ```toml
+# config.toml
 [testbench-requirement-service]
 reader_class = "JsonlRequirementReader"
 
@@ -73,7 +74,7 @@ requirements_path = "requirements/jsonl/"
 | **Projects** | Top-level directories inside `requirements_path` | Each directory is a project |
 | **Baselines** | `.jsonl` files inside a project directory | Each file is a baseline |
 | **Requirements** | JSON objects (one per line) in a `.jsonl` file | Each line is a requirement or folder node |
-| **User-defined attributes** | `UserDefinedAttributes.json` at the top of `requirements_path` | Defines available types of user defined fields (UDF) |
+| **User-defined attributes** | `UserDefinedAttributes.json` at the top of `requirements_path` | Defines available types of user defined fields (UDF)|
 
 ## Requirement JSON schema
 
@@ -119,18 +120,18 @@ Each line in a baseline `.jsonl` file is a JSON object representing either a req
 
 | Field | Type | Description |
 |-------|------|-------------|
-| `name` | string | Requirement name |
-| `extendedID` | string | External ID |
-| `key.id` | string | Unique identifier |
-| `key.version` | object | Version info: `name`, `date`, `author`, `comment` |
-| `owner` | string | Responsible person |
-| `status` | string | Requirement status |
-| `priority` | string | Priority level |
-| `requirement` | boolean | `true` = requirement, `false` = folder/group |
-| `description` | string | Requirement description |
-| `documents` | string[] | Attached document references |
-| `parent` | string or null | Parent node ID (`null` for roots) |
-| `userDefinedAttributes` | array | User-defined fields (see below) |
+| `name` | String | Requirement name |
+| `extendedID` | String | Extended ID |
+| `key.id` | String | Unique identifier |
+| `key.version` | Object | Version info: `name`, `date`, `author`, `comment` |
+| `owner` | String | Responsible person |
+| `status` | String | Requirement status |
+| `priority` | String | Priority level |
+| `requirement` | Boolean | `true` = requirement, `false` = folder/group |
+| `description` | String | Requirement description |
+| `documents` | List[String] | Attached document references |
+| `parent` | String or null | Parent node ID (`null` for roots) |
+| `userDefinedAttributes` | List[Object] | User-defined fields (see below) |
 
 ## UserDefinedAttributes.json