DOCS: Documentation Updates II

.github/workflows/gh-pages.yml

@@ -15,8 +15,6 @@ jobs:
       - uses: actions/checkout@v4
         with:
           fetch-depth: 0
-          sparse-checkout: |
-            docs
 
       - name: Set up Python
         uses: actions/setup-python@v5

docs/arguments.md

@@ -50,6 +50,7 @@ pydm trace/main.py -m "INPUT_FILE = trace/examples/FormulaExample.trc"
 
 Shows Trace's help message, which outlines the available arguments for users.
 
+
 ## Version Number
 
 `-v` or `--version`

docs/installation.md

@@ -5,13 +5,16 @@
 - pip (Python package manager)
 - (Optional) conda for environment management
 
+
 ## Clone the Repository
 
 ``` bash
 git clone https://github.com/slaclab/trace.git
 ```
 
+
 ## Create and Activate a Virtual Environment (Recommended)
+
 Using `venv`:
 ``` bash
 python3 -m venv .venv
@@ -24,7 +27,9 @@ conda env create -f environment.yml
 conda activate trace
 ```
 
+
 ## Install Dependencies
+
 If using pip:
 ``` bash
 pip install -r requirements.txt
@@ -35,12 +40,15 @@ Or with `conda` (if you created the environment above, dependencies are already
 conda env update -f environment.yml
 ```
 
+
 ## Running Trace
-To launch Trace:
-``` bash
-pydm trace/main.py
-```
 
-For more options and arguments, see the [Arguments & Macros] page.
+The main startup file for trace is located at `trace/main.py`.
+
+Trace can be launched using PyDM, and users can pass in additional [arguments and macros].
 
-  [Arguments & Macros]: arguments.md
+  [arguments and macros]: arguments.md
+
+``` bash
+pydm trace/main.py
+```

docs/io.md

@@ -4,7 +4,9 @@ Trace allows users to export their current configuration of the application into
 
 The importing and exporting features can be found in the menu bar at the top of the application under the Action menu. Alternatively, users can export their current configuration with `Ctrl+S` or import a file with `Ctrl+L`.
 
-Files can also be imported on startup using the `-i` flag followed by the path to the file. Find more information on application arguments [here](../reference/trace.md#arguments-and-macros).
+Files can also be imported on startup using the `-i` flag followed by the path to the file. Find more information on application arguments [here].
+
+  [here]: arguments.md
 
 
 
@@ -19,7 +21,9 @@ Save files for the Java-based Archive Viewer can also be imported into Trace. Th
 
 Trace will not save new files in the Java-based Archive Viewer's format, only as `.trc` files.
 
-Files can be converted en masse from the Java-based file format to Trace's formate using the [CLI file converter tool](file_conversion.md).
+Files can be converted en masse from the Java-based file format to Trace's formate using the [CLI file converter tool].
+
+  [CLI file converter tool]: tools/file_converter.md
 
 
 ### StripTool Save Files
@@ -28,9 +32,9 @@ Save files for the StripTool can be converted using the same tool or imported di
 
 Trace will not save new files in the Java-based Archive Viewer's format, only as `.trc` files.
 
-Files can be converted en masse from the StripTool file format to Trace's formate using the [CLI file converter tool](file_conversion.md).
+Files can be converted en masse from the StripTool file format to Trace's formate using the file converter tool.
 
 
 ### Note About Colors
 
-Colors in the save file will typically be represented as RGB values in hexidecimal format. Since the string will be passed into a QColor when loaded, these strings can be names of colors as well e.g. "red", "blue", "white", etc.
+Colors in the save file will typically be represented as RGB values in hexidecimal format. Since the string will be passed into a QColor when loaded, these strings can be names of colors as well e.g. "red", "blue", "white", etc.

docs/reference/trace.md

@@ -1,13 +1,3 @@
 # Main
 
-The main startup file for trace is located at `trace/main.py`.
-
-Trace can be launched using PyDM, and users can pass in additional [arguments and macros].
-
-  [arguments and macros]: ../arguments.md
-
-``` bash
-pydm trace/main.py
-```
-
 ::: main

docs/y_axes.md

@@ -10,35 +10,85 @@ From adding/removing axes, hiding axes, or changing an axis' properties, users h
 </figure>
 
 
-While most X-Axis (timerange) controls should be conducted through the mouse, users can set their time range in the Axes tab as well. This can be done with the 2 datetime widgets at the top of the tab. They can be used to set an absolute date and time for either side of the X-Axis.
 
-Users can control which Y-Axis each curve is attached to from the Traces tab. [More information here](traces.md#trace-properties).
+## Adding Axes
 
+Users can create new Y-axes to organize [traces] by clicking the button labeled "New Axis" at the bottom of the configuration section.
+The new axis won't have any associated traces on creation, but the can be added and configured.
 
+  [traces]: traces.md
 
-## Adding Axes
 
-Y-Axes should be added automatically, but users can add more as needed using the "Add Axis" button at the bottom of the section. By default, new axes will have these properties:
-- Named "Axis #" (where `#` is an incrementing number)
-- Oriented to the left
-- Auto Range enabled
-- Log Mode disabled
-- Not Hidden
+
+## Renaming Axes
+
+By default, new Y-axes are names "Y-Axis <#>" where `<#>` is an incrementing number.
+Users are able to rename an axis by editing the text in the associate text box.
 
 
 
 ## Deleting Axes
 
-Users can remove axes by clicking the "Delete Row" button for the given axis in the rightmost column. Deleting an axis will remove the axis from both the table and the plot, as well as all of the traces attached to that axis.
+Users can remove axes by clicking the :fontawesome-regular-trash-can: button for the given axis on the right side of the section.
+Deleting an axis will remove the axis from both the table and the plot, as well as all of the traces attached to that axis.
 
 
 
 ## Hiding Axes
 
-Users have the option to hide/show Y-Axes on the plot using the checkbox in the second to last column. By hiding a Y-Axis, all curves attached to that axis will be hidden as well.
+Users have the option to hide/show Y-axes on the plot using the checkbox labeled "Active" on the right side of the section.
+Hiding a Y-axis will hide all traces attached to it as well.
+
+
+
+## Axis Settings
+
+Users can change an axis' vertical range and settings on an axis-by-axis basis.
+
+Some of an axis' settings can be configured by clicking the associated :octicons-gear-16: button on the right side of the section.
+This will open a pop-up window that allows for a lot of customization of the axis.
+It looks like this.
+
+<figure markdown="span">
+  ![Image of Axis Settings](images/axis_settings.png)
+</figure>
+
+
+### Vertical Range
+
+An axis' range can be changed in a few different ways.
+By default, an axis will automatically scale its range to show all data for its traces.
+This feature can be enabled/disabled using the checkbox labeled "Auto".
+It will also be automatically disabled if the user changes the range manually in one of the following ways.
+
+Another, more common way for users to change the range is by scrolling/dragging on the plot.
+This can be done on individual axes or on all axes at once.
+See [Mouse Controls] for more details.
+
+  [Mouse Controls]: overview/plot_section.md#mouse-controls
+
+Finally, users also have the option to set the range manually by altering the values in the text boxes labeled `min, max` in the configuration section.
+This will result in the Y-axis being locked at that range, even if trace data isn't in that range.
+
+
+### Orientation
+
+Sets if the axis is displayed on the left or right side of the plot.
+This doesn't affect the data or the plot and is purely a cosmetic change.
+
+
+### Log Mode
+
+Sets if the axis is on a linear scale or a [logarithmic scale].
+
+  [logarithmic scale]: https://en.wikipedia.org/wiki/Logarithmic_scale
+
 
+### Y-Axis Gridline
 
+Sets if gridlines are shown on the plot.
+These will be horizontal lines at all major ticks on the Y-axis.
 
-## Moving Traces
+Gridlines can be enabled/disabled individually here, or enabled/disabled for all axes in the [plot settings] pop-up.
 
-Users are able to move a trace from one y-axis to another by
+  [plot settings]: plot_config.md

mkdocs.yml

@@ -80,6 +80,7 @@ nav:
   - Home: index.md
   - Getting Started:
     - installation.md
+    - Input Arguments: arguments.md
     - Interface Overview:
       - overview.md
       - Plot Section: overview/plot_section.md
@@ -88,7 +89,6 @@ nav:
     - Traces: traces.md
     - Y-Axes: y_axes.md
     - Plot Config: plot_config.md
-    - Arguments & Macros: arguments.md
     - Import/Export: io.md
     - Tools:
       - File Converter: tools/file_converter.md