Skip to content

Commit 76c31e5

Browse files
committed
Update docs
1 parent 9aa4e80 commit 76c31e5

4 files changed

Lines changed: 5 additions & 5 deletions

File tree

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ testbench-requirement-service [COMMAND] [OPTIONS]
1313

1414
---
1515

16-
## Commands Overview
16+
## Commands overview
1717

1818
| Command | Description |
1919
|---|---|

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -216,7 +216,7 @@ forwarded_secret = "secret"
216216
Without proxy configuration, the service ignores all proxy headers. This is safe. Only enable proxy settings when actually behind a proxy.
217217
:::
218218

219-
**Nginx example**
219+
#### Nginx example
220220

221221
**Nginx configuration:**
222222

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ title: Introduction
2626
| **Requirements tree** | The baseline content exposed as a tree of folders/groups and leaf requirements. |
2727
| **Reader** | A pluggable component that knows how to fetch projects, baselines, and requirements from a specific data source. |
2828

29-
## How it works
29+
## Architecture
3030

31-
The service runs a [Sanic](https://sanic.dev)-based HTTP server and delegates all domain logic to a configured `RequirementReader` implementation. Reader configuration can live inline in the main `config.toml` or in a separate file.
31+
The service runs a [Sanic](https://sanic.dev)-based HTTP server and delegates all domain logic to a configured `RequirementReader` implementation.
3232

3333
```
3434
┌──────────────────────────────────────┐

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ title: JSONL Reader
55

66
# JSONL Reader
77

8-
The JSONL reader is the **default reader**. It reads requirements from JSON Lines (`.jsonl`) files stored on disk. No extra dependencies are required.
8+
The JSONL reader is the **default reader**. It reads requirements from [JSON Lines](https://jsonlines.org/) (`.jsonl`) files stored on disk. No extra dependencies are required.
99

1010
**When to use:** Your requirements are exported or generated as `.jsonl` files, or you want the simplest setup with no external dependencies.
1111

0 commit comments

Comments
 (0)