Merge pull request #57 from product-science/tcharchian-patch-6

Tcharchian patch 6

Author: mtvnastya

docs/release-notes/Quick-Start-Guide.md

@@ -8,8 +8,8 @@ the full potential of the PS Tool.
 The Quick Start Guide will be accessible to users within the tool at all times, ensuring that immediate support is readily available.
 
 The Quick Start Guide comprises 3 main components:
+
 - **Introduction Video** A concise, less than 1-minute video that provides an overview of how PS Tool works.‍
 - **Step-by-Step Guide** A detailed step-by-step guide on how to perform various tasks using PS Tool. This section ensures that users gain a 
 solid grasp of important features that can empower their analysis.
-- **Tutorial on how to identify insights** Building upon the features learned in previous section, this session focuses on guiding users on how 
-to use these features to find insights efficiently with real life examples and best practices.
+- **Tutorial on how to identify insights** Building upon the features learned in previous section, this session focuses on guiding users on how to use these features to find insights efficiently with real life examples and best practices.

docs/release-notes/R1.1-New-UX-&-UI.md

@@ -8,6 +8,7 @@
 - Sort flow by favorites, popularity, last edited, and by name
 
 ## Flow View
+
 - View the list of traces associated with a specific flow 
 - Edit flow name and description
 - Subscribe to flow updates
@@ -18,6 +19,7 @@
 - Filter any field of the table and remove traces from the flow or attach them to a different flow
 
 ## Unassigned traces view
+
 - Assign traces to one or multiple flows
 - Quick filter by "My traces only”
 - Filter any field of the table
@@ -27,27 +29,27 @@
 ![R1.1-New-UX-&-UI-2](R1.1-New-UX-&-UI-2.png)
 
 - Main Timeline (Flame Chart)
-  -   Display slices on timeline, sorted by time
-  -   Display slices full name on hover
-  -   Ability to zoom with WASD or trackpad
-  -   Arrow measurement. Enable you to understand the duration of one function to another
-  -   Ability to add/remove any thread to favorites
+    - Display slices on timeline, sorted by time
+    - Display slices full name on hover
+    - Ability to zoom with WASD or trackpad
+    - Arrow measurement. Enable you to understand the duration of one function to another
+    - Ability to add/remove any thread to favorites
 - Global Timeline (Aggregation View)
-  -   Display preview of the whole timeline in a condensed view
-  -   Ability to set start and end of the focus zone of the video timeline, synced with the flame graph timeline
+    - Display preview of the whole timeline in a condensed view
+    - Ability to set start and end of the focus zone of the video timeline, synced with the flame graph timeline
 - Search 
 - Connections
-  -   Build new connections
-  -   Build connection with real-time feedback
-  -   Visually highlighting slices available for connections
+    - Build new connections
+    - Build connection with real-time feedback
+    - Visually highlighting slices available for connections
 - Flags
-  -   Ability to add/remove flag
-  -   Ability to drag and change flag position
-  -   Ability to label, change color, and add notes to flags
+    - Ability to add/remove flag
+    - Ability to drag and change flag position
+    - Ability to label, change color, and add notes to flags
 - Details View
-  -   Display slice info
-  -   Display execution path info
+    - Display slice info
+    - Display execution path info
 - Execution paths feature
-  -   Ability to show the full execution path available for the selected slice
-  -   Filter out inactive threads and sort remaining threads by start time
-  -   Show only the necessary depth of thread
+    - Ability to show the full execution path available for the selected slice
+    - Filter out inactive threads and sort remaining threads by start time
+    - Show only the necessary depth of thread

docs/release-notes/R1.2-Admin.md

@@ -5,6 +5,7 @@
 ![Admin-Screen](Admin-Screen.png)
 
 A system for monitoring, maintaining, and controlling user access to your teams and projects. This is where you can:
+
 - Update project icons and details
 - Remove project
 - Update team member's role
@@ -21,10 +22,13 @@ A system for monitoring, maintaining, and controlling user access to your teams
 - Register account
 
 ## Flow Library 
+
 - Ability to add, save and edit Flow titles and descriptions.
 
 ## Trace Viewer
+
 [New]
+
 - Tools to prioritize and deprioritize threads so that you can better see an execution path
 - Pin thread
 - Deprioritize thread
@@ -38,15 +42,18 @@ path temporarily and see the execution path better.
 initial exploration process.
 
 [Improved]
+
 - Slice name and connection lines styles updated for readability enhancement
 - Ability to zoom into small slices and read their names.
 
 ## Mobile app
+
 - Ability to create Flows 
 - Ability to share and upload traces to PS Tool and
 - SSO with Google
 
 ## Miscellaneous
+
 - Customer Support System
 - You can now file a bug or feature request directly to us. 
 - Documentation 

docs/release-notes/R1.3-Video.md

@@ -3,35 +3,41 @@
 ![R1.3-Video](R1.3-Video.png)
 
 ## New Feature - Video preview synced with trace
+
 With the new Video synced with trace feature you will be able to see what’s happening on the phone screen at every point of the recorded 
 trace.
 
 Video synced with trace feature allows you to:
+
 - Quickly find the beginning and end of user flows
 - See the user actions
 - Visually identify performance opportunities (like jitteriness, lags and long network requests)
 - Visually identify when the screen was updated
 
 Seeing how your application functions in real life provides valuable context that helps to understand what’s happening - even when the code 
 is hard to follow:
+
 - Ability to upload recorded video via PS Tool Web UI to a specific trace
 - Video preview thumbnails that allow you to quickly navigate video on the global timeline
 - Video tab
-  -   Large Preview of the video recording
-         -   Ability to play and pause video
-         -   Ability to loop video
-         -   Ability to delete video
+    - Large Preview of the video recording
+        - Ability to play and pause video
+        - Ability to loop video
+        - Ability to delete video
 
 ## Companion App
+
 - Ability to upload recorded video via Companion app to a specific trace
 - Added information with User Flow description
 - Added information with project platform information in the project list
 - Added information with user role
 
 ## Trace Viewer
+
 - Vertical scroller on flamegraph, with the ability to jump to the top or bottom
 - Ability to pin a selected choreographer and made it available to anyone opening the trace
 - Disable pin-zoom for non flame chart elements
 
 ## Misc
+
 - Updated technical copies to human readable copies for all error messages

docs/release-notes/R1.4-Annotations.md

@@ -4,11 +4,9 @@ At Product Science, we believe that optimizing your app's performance should sta
 that drive engagement and app retention. In this release, we are reinforcing our approach by helping our customers define the most critical 
 user flows even before the team begins to look at the code.
 
-In the new Annotations screen, even non-technical customers will be able to easily mark the beginning and end of the user flow that requires 
-performance optimization. This is achieved by placing human-readable annotations on top of the video.
-The new Processes x Annotations screen provides tools to connect the human-readable annotations to the code level of your app, making it easy
-to understand exactly where on the code level the user flow starts and ends.
-The updated Trace Viewer screen will highlight the beginning and end of the user flow so engineers can focus on this specific part of the 
+- In the new Annotations screen, even non-technical customers will be able to easily mark the beginning and end of the user flow that requires performance optimization. This is achieved by placing human-readable annotations on top of the video.
+- The new Processes x Annotations screen provides tools to connect the human-readable annotations to the code level of your app, making it easy to understand exactly where on the code level the user flow starts and ends.
+- The updated Trace Viewer screen will highlight the beginning and end of the user flow so engineers can focus on this specific part of the 
 trace and disregard the rest.
 
 ## New Screen - Annotations