Merge pull request slaclab#63 from YektaY/readme

DOCS: small changes to readme and index.md

Author: YektaY

.github/workflows/ISSUE_TEMPLATE/bug-report.md

@@ -0,0 +1,60 @@
+name: Bug report
+description: Report an issue or bug with the project.
+title: "[BUG] - "
+labels: bug
+assignees: ''
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Please provide a clear and concise description of the bug.**
+        
+  - type: textarea
+    id: description
+    attributes:
+      label: Describe the bug
+      description: A clear and concise description of what the bug is.
+      placeholder: The bug occurs when...
+
+  - type: textarea
+    id: expected_behavior
+    attributes:
+      label: Expected behavior
+      description: A clear and concise description of what you expected to happen.
+      placeholder: I expected...
+
+  - type: textarea
+    id: steps_to_reproduce
+    attributes:
+      label: Steps to Reproduce
+      description: Steps to reproduce the bug.
+      placeholder: |
+        1. Go to...
+        2. Click on...
+        3. Scroll down to...
+        4. See error
+
+  - type: textarea
+    id: possible_solution
+    attributes:
+      label: Possible solution (optional)
+      description: Suggest a fix or reason for the bug, if you have any.
+      placeholder: A possible solution could be...
+
+  - type: input
+    id: platform
+    attributes:
+      label: My platform
+      description: Provide details about your system.
+      placeholder: |
+        * OS Version: ...
+        * Python Version: ...
+        * Package Versions: ...
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context, links, or information about the bug.
+      placeholder: Include logs, screenshots, or other details here.

.github/workflows/ISSUE_TEMPLATE/bug-report.yml

@@ -0,0 +1,32 @@
+name: Feature request
+description: Suggest a new feature or enhancement for the project.
+title: "[FEATURE] - "
+labels: enhancement
+assignees: ''
+
+body:
+  - type: markdown
+    attributes:
+      value: |
+        **Please provide a clear and concise description of the feature you'd like to propose.**
+        
+  - type: textarea
+    id: problem
+    attributes:
+      label: What's the problem this feature will solve?
+      description: A clear and concise description of the problem or pain point.
+      placeholder: This feature would solve...
+
+  - type: textarea
+    id: solution
+    attributes:
+      label: Describe the solution you'd like
+      description: A clear and concise description of what you want to happen.
+      placeholder: The ideal solution would be...
+
+  - type: textarea
+    id: additional_context
+    attributes:
+      label: Additional context
+      description: Add any other context, links, or resources to support your feature request.
+      placeholder: Include any relevant links, screenshots, or references here.

.github/workflows/ISSUE_TEMPLATE/feature-request.md

@@ -1,6 +1,6 @@
 # Trace
 
-trace is an PyDM-based application developed. trace has been built to replace the antiquated StripTool and Java Archive Viewer applications used to plot EPICS data. trace is a flexible, modern application for plotting live data (Channel Access or PV Access), and historical data from the EPICS Archive Appliance. With built in conveniences like an archived PV search, and designed to be easily launched from PyDM widgets, files, or the command line, trace will provide an improved user experience for accelerator staff. Trace is an open-source project.   
+trace is an PyDM-based application developed at SLAC National Accelerator Laboratory. trace has been built to replace the antiquated StripTool and Java Archive Viewer applications used to plot EPICS data. trace is a flexible, modern application for plotting live data (Channel Access or PV Access), and historical data from the EPICS Archive Appliance. With built in conveniences like an archived PV search, and designed to be easily launched from PyDM widgets, files, or the command line, trace will provide an improved user experience for accelerator staff. Trace is an open-source project.   
 
 For more information and a how to guide on trace see [the project's website](https://slaclab.github.io/trace/)
 <p align="center">

.github/workflows/ISSUE_TEMPLATE/feature-request.yml

@@ -1,4 +1,5 @@
 # Trace
 
-[trace](https://github.com/slaclab/trace) is a PyDM-based application developed at SLAC. trace has been built to replace the antiquated StripTool and Java Archive Viewer applications used to plot EPICS data. trace is a flexible, modern application for plotting live data (Channel Access or PV Access), and historical data from the EPICS Archive Appliance. With built in conveniences like an archived PV search, and designed to be easily launched from PyDM widgets, files, or the command line, trace will provide an improved user experience for accelerator staff. Trace is an open-source project.   
+[Trace](https://github.com/slaclab/trace) is a PyDM-based application developed at SLAC National Accelerator Laboratory. Trace has been built to replace the antiquated StripTool and Java Archive Viewer applications used to plot EPICS data. Trace is a flexible, modern application for plotting live data (Channel Access or PV Access), and historical data from the EPICS Archive Appliance. With built in conveniences like an archived PV search, and designed to be easily launched from PyDM widgets, files, or the command line, Trace will provide an improved user experience for accelerator staff. Trace is an open-source project.   
 
+![Image of Trace](images/Index_Image.png)

README.md

@@ -3,29 +3,31 @@ repo_url: https://github.com/slaclab/trace
 repo_name: slaclab/trace
 
 nav:
-    - Home: index.md
-    - How To:
-        - Overview: how_to/overview.md
-        - Traces: how_to/traces.md
-        - Traces Table Menu: how_to/traces_table_menu.md
-        - Axes: how_to/axes.md
-        - Plot Config: how_to/plot_config.md
-        - Import/Export: how_to/io.md
-        - Convert Save Files: how_to/file_conversion.md
-    - API Reference:
-        - Trace: api_reference/trace.md
-        - Traces Table: api_reference/traces_table.md
-        - Axis Table: api_reference/axis_table.md
-        - Plot Config: api_reference/plot_config.md
+  - Home: index.md
+  - How To:
+      - Overview: how_to/overview.md
+      - Traces: how_to/traces.md
+      - Traces Table Menu: how_to/traces_table_menu.md
+      - Axes: how_to/axes.md
+      - Plot Config: how_to/plot_config.md
+      - Import/Export: how_to/io.md
+      - Convert Save Files: how_to/file_conversion.md
+  - API Reference:
+      - Trace: api_reference/trace.md
+      - Traces Table: api_reference/traces_table.md
+      - Axis Table: api_reference/axis_table.md
+      - Plot Config: api_reference/plot_config.md
+
 theme:
+  name: material
+  # custom_dir: overrides
   icon:
     repo: fontawesome/brands/github
-  name: material
-
   features:
     - navigation.top
     - navigation.tabs
     - navigation.indexes
+    - navigation.footer
   palette:
     - media: "(prefers-color-scheme: light)"
       scheme: default
@@ -40,13 +42,17 @@ theme:
         icon: material/toggle-switch
         name: Switch to light mode
 
+extra:
+  generator: false
+
 markdown_extensions:
   - pymdownx.highlight
   - pymdownx.superfences
 
 plugins:
-    - search
-    - mkdocstrings:
-        handlers:
-          python:
-            paths: [trace]
+  - search
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [trace]
+