docs: small fixes

szkiba · Feb 2, 2024 · 950177a · 950177a
1 parent 3de0462
commit 950177a
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -8,10 +8,10 @@ Also available as a standalone terminal-based metrics dashboard viewer ([k6top](
 
 ## Features
 
-- Quick overview of the k6 test run in the same temrinal
+- Quick overview of the k6 test run in the same terminal
 - Displays the current status of the thresholds
-- Displays a table of metrics
-- Displays a chart of relevant metrics
+- Displays tables of metrics
+- Displays charts of relevant metrics
 - The values of the metrics are updated dynamically
 - It is easy to use even on a remote computer
 
@@ -38,7 +38,7 @@ You can download pre-built k6 binaries from the [Releases](https://github.com/sz
 
 Go version 1.21 is required as a minimum for the build.
 
-The [xk6](https://github.com/grafana/xk6) build tool can be used to build a k6 that will include xk6-faker extension:
+The [xk6](https://github.com/grafana/xk6) build tool can be used to build a k6 that will include xk6-top extension:
 
 ```bash
 $ xk6 build --with github.com/szkiba/xk6-top@latest
@@ -75,7 +75,7 @@ Key                  | Function
 `+`, `Shift+Down`    | Expand, show more details
 `-`, `Shift+Up`      | Collapse, show less details
 
-There are also charts on some tabs. Due to the limitations of the terminal, one diagram is displayed at a time. You can switch between diagrams with the `Shift+Right` and `Shift+Left` keys.
+There are also charts on some tabs. Due to the limitations of the terminal, one chart is displayed at a time. You can switch between charts with the `Shift+Right` and `Shift+Left` keys.
 
 Certain tabs (on which data is not available) may be disabled. Their names appear in italics.
 
@@ -89,15 +89,15 @@ The most important element of the *Overview* tab is the table containing the cur
 
 The aggregated metric values are available in tabular form on the tabs named according to the type of metric (*Trends*, *Counters*, *Rates*, *Gauges*).
 
-By default, the table contains the tags expanded. Lines containing tags can be collapsed with the `-` key or the `Shift+Up` key combination. They can be expanded at any time later with the `+` key or the `Shift+Down` key combination.
+By default, the table contains the tags expanded. Rows containing tags can be collapsed with the `-` key or the `Shift+Up` key combination. They can be expanded at any time later with the `+` key or the `Shift+Down` key combination.
 
 ### Metrics charts
 
 The most important metrics are also available in the form of a time chart on the tabs with names corresponding to the protocol (*HTTP*, *gRPC*, *WS*, *Browser*).
 
 Due to the limitations of the terminal, one chart can be seen on these tabs at a time. A second-level navigation enables the choice of a chart within a tab. You can switch to the next/previous chart with the key combinations `Shift+Right` and `Shift+Left`.
 
-The diagram displaying the *trend* type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the `-` key or the `Shift+Up` key combination. They can be displayed at any type later with repeatedly using the `+` key or the `Shift+Down` key combination.
+The chart displaying the *trend* type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the `-` key or the `Shift+Up` key combination. They can be displayed at any type later with repeatedly using the `+` key or the `Shift+Down` key combination.
 <!-- #endregion help -->
 
 ## Command Line

diff --git a/docs/help.md b/docs/help.md
@@ -14,7 +14,7 @@ Key                  | Function
 `+`, `Shift+Down`    | Expand, show more details
 `-`, `Shift+Up`      | Collapse, show less details
 
-There are also charts on some tabs. Due to the limitations of the terminal, one diagram is displayed at a time. You can switch between diagrams with the `Shift+Right` and `Shift+Left` keys.
+There are also charts on some tabs. Due to the limitations of the terminal, one chart is displayed at a time. You can switch between charts with the `Shift+Right` and `Shift+Left` keys.
 
 Certain tabs (on which data is not available) may be disabled. Their names appear in italics.
 
@@ -28,12 +28,12 @@ The most important element of the *Overview* tab is the table containing the cur
 
 The aggregated metric values are available in tabular form on the tabs named according to the type of metric (*Trends*, *Counters*, *Rates*, *Gauges*).
 
-By default, the table contains the tags expanded. Lines containing tags can be collapsed with the `-` key or the `Shift+Up` key combination. They can be expanded at any time later with the `+` key or the `Shift+Down` key combination.
+By default, the table contains the tags expanded. Rows containing tags can be collapsed with the `-` key or the `Shift+Up` key combination. They can be expanded at any time later with the `+` key or the `Shift+Down` key combination.
 
 ### Metrics charts
 
 The most important metrics are also available in the form of a time chart on the tabs with names corresponding to the protocol (*HTTP*, *gRPC*, *WS*, *Browser*).
 
 Due to the limitations of the terminal, one chart can be seen on these tabs at a time. A second-level navigation enables the choice of a chart within a tab. You can switch to the next/previous chart with the key combinations `Shift+Right` and `Shift+Left`.
 
-The diagram displaying the *trend* type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the `-` key or the `Shift+Up` key combination. They can be displayed at any type later with repeatedly using the `+` key or the `Shift+Down` key combination.
+The chart displaying the *trend* type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the `-` key or the `Shift+Up` key combination. They can be displayed at any type later with repeatedly using the `+` key or the `Shift+Down` key combination.
diff --git a/gh b/gh
diff --git a/internal/ui/help/help-dark.ansi b/internal/ui/help/help-dark.ansi
@@ -14,7 +14,7 @@
 [0m[38;5;252m[0m[38;5;252m  +, Shift+Down   │ Expand, show more details[0m
 [0m[38;5;252m[0m[38;5;252m  -, Shift+Up     │ Collapse, show less details[0m
 [0m
-[38;5;252m[0m[38;5;252m[0m[38;5;252mThere are also charts on some tabs. Due to the limitations of the terminal, one diagram is displayed at a time. You can switch between diagrams with the [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;252m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;252m keys.[0m
+[38;5;252m[0m[38;5;252m[0m[38;5;252mThere are also charts on some tabs. Due to the limitations of the terminal, one chart is displayed at a time. You can switch between charts with the [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;252m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;252m keys.[0m
 
 [38;5;252m[0m[38;5;252m[0m[38;5;252mCertain tabs (on which data is not available) may be disabled. Their names appear in[0m[38;5;252m italics.[0m
 [38;5;252m[0m[38;5;252m[0m
@@ -28,12 +28,12 @@
 [0m
 [38;5;252m[0m[38;5;252m[0m[38;5;252mThe aggregated metric values are available in tabular form on the tabs named according to the type of metric ([0m[38;5;252;3mTrends[0m[38;5;252m, [0m[38;5;252;3mCounters[0m[38;5;252m, [0m[38;5;252;3mRates[0m[38;5;252m, [0m[38;5;252;3mGauges[0m[38;5;252m).[0m
 
-[38;5;252m[0m[38;5;252m[0m[38;5;252mBy default, the table contains the tags expanded. Lines containing tags can be collapsed with the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;252m key combination. They can be expanded at any time later with the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;252m key[0m[38;5;252m combination.[0m
+[38;5;252m[0m[38;5;252m[0m[38;5;252mBy default, the table contains the tags expanded. Rows containing tags can be collapsed with the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;252m key combination. They can be expanded at any time later with the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;252m key[0m[38;5;252m combination.[0m
 [38;5;252m[0m[38;5;252m[0m
 [0m[38;5;39;1m[0m[38;5;39;1m[0m[38;5;39;1m### [0m[38;5;39;1mMetrics[0m[38;5;39;1m charts[0m[38;5;252m[0m
 [0m
 [38;5;252m[0m[38;5;252m[0m[38;5;252mThe most important metrics are also available in the form of a time chart on the tabs with names corresponding to the protocol ([0m[38;5;252;3mHTTP[0m[38;5;252m, [0m[38;5;252;3mgRPC[0m[38;5;252m, [0m[38;5;252;3mWS[0m[38;5;252m, [0m[38;5;252;3mBrowser[0m[38;5;252m).[0m
 
 [38;5;252m[0m[38;5;252m[0m[38;5;252mDue to the limitations of the terminal, one chart can be seen on these tabs at a time. A second-level navigation enables the choice of a chart within a tab. You can switch to the next/previous chart with the key combinations [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;252m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;252m.[0m
 
-[38;5;252m[0m[38;5;252m[0m[38;5;252mThe diagram displaying the [0m[38;5;252;3mtrend[0m[38;5;252m type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;252m key combination. They can be displayed at any type later with repeatedly using the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;252m key[0m[38;5;252m combination.[0m
+[38;5;252m[0m[38;5;252m[0m[38;5;252mThe chart displaying the [0m[38;5;252;3mtrend[0m[38;5;252m type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;252m key combination. They can be displayed at any type later with repeatedly using the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;252m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;252m key[0m[38;5;252m combination.[0m
diff --git a/internal/ui/help/help-light.ansi b/internal/ui/help/help-light.ansi
@@ -14,7 +14,7 @@
 [0m[38;5;234m[0m[38;5;234m  +, Shift+Down   │ Expand, show more details[0m
 [0m[38;5;234m[0m[38;5;234m  -, Shift+Up     │ Collapse, show less details[0m
 [0m
-[38;5;234m[0m[38;5;234m[0m[38;5;234mThere are also charts on some tabs. Due to the limitations of the terminal, one diagram is displayed at a time. You can switch between diagrams with the [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;234m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;234m keys.[0m
+[38;5;234m[0m[38;5;234m[0m[38;5;234mThere are also charts on some tabs. Due to the limitations of the terminal, one chart is displayed at a time. You can switch between charts with the [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;234m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;234m keys.[0m
 
 [38;5;234m[0m[38;5;234m[0m[38;5;234mCertain tabs (on which data is not available) may be disabled. Their names appear in[0m[38;5;234m italics.[0m
 [38;5;234m[0m[38;5;234m[0m
@@ -28,12 +28,12 @@
 [0m
 [38;5;234m[0m[38;5;234m[0m[38;5;234mThe aggregated metric values are available in tabular form on the tabs named according to the type of metric ([0m[38;5;234;3mTrends[0m[38;5;234m, [0m[38;5;234;3mCounters[0m[38;5;234m, [0m[38;5;234;3mRates[0m[38;5;234m, [0m[38;5;234;3mGauges[0m[38;5;234m).[0m
 
-[38;5;234m[0m[38;5;234m[0m[38;5;234mBy default, the table contains the tags expanded. Lines containing tags can be collapsed with the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;234m key combination. They can be expanded at any time later with the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;234m key[0m[38;5;234m combination.[0m
+[38;5;234m[0m[38;5;234m[0m[38;5;234mBy default, the table contains the tags expanded. Rows containing tags can be collapsed with the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;234m key combination. They can be expanded at any time later with the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;234m key[0m[38;5;234m combination.[0m
 [38;5;234m[0m[38;5;234m[0m
 [0m[38;5;27;1m[0m[38;5;27;1m[0m[38;5;27;1m### [0m[38;5;27;1mMetrics[0m[38;5;27;1m charts[0m[38;5;234m[0m
 [0m
 [38;5;234m[0m[38;5;234m[0m[38;5;234mThe most important metrics are also available in the form of a time chart on the tabs with names corresponding to the protocol ([0m[38;5;234;3mHTTP[0m[38;5;234m, [0m[38;5;234;3mgRPC[0m[38;5;234m, [0m[38;5;234;3mWS[0m[38;5;234m, [0m[38;5;234;3mBrowser[0m[38;5;234m).[0m
 
 [38;5;234m[0m[38;5;234m[0m[38;5;234mDue to the limitations of the terminal, one chart can be seen on these tabs at a time. A second-level navigation enables the choice of a chart within a tab. You can switch to the next/previous chart with the key combinations [0m[38;5;203m [0m[38;5;203mShift+Right[0m[38;5;203m [0m[38;5;234m and [0m[38;5;203m [0m[38;5;203mShift+Left[0m[38;5;203m [0m[38;5;234m.[0m
 
-[38;5;234m[0m[38;5;234m[0m[38;5;234mThe diagram displaying the [0m[38;5;234;3mtrend[0m[38;5;234m type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;234m key combination. They can be displayed at any type later with repeatedly using the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;234m key[0m[38;5;234m combination.[0m
+[38;5;234m[0m[38;5;234m[0m[38;5;234mThe chart displaying the [0m[38;5;234;3mtrend[0m[38;5;234m type metric contains the percentile values in addition to the average value. Percetile series can be hidden individually by repeatedly using the [0m[38;5;203m [0m[38;5;203m-[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Up[0m[38;5;203m [0m[38;5;234m key combination. They can be displayed at any type later with repeatedly using the [0m[38;5;203m [0m[38;5;203m+[0m[38;5;203m [0m[38;5;234m key or the [0m[38;5;203m [0m[38;5;203mShift+Down[0m[38;5;203m [0m[38;5;234m key[0m[38;5;234m combination.[0m