diff --git a/website/docs/getting-started.md b/website/docs/getting-started.md index 138422d6b..9daf288d6 100644 --- a/website/docs/getting-started.md +++ b/website/docs/getting-started.md @@ -4,15 +4,15 @@ sidebar_position: 2 # Getting Started In this section, you will learn how to use memlab to detect a memory leak. -Please make sure you have completed a [installation](./installation.md) -step in your local machine. We start with defining the scenario file where we +Please make sure you have completed the [installation](./installation.md) +step on your local machine. We'll start with defining the scenario file where we specify how memlab should interact with our page. ## Write a Test Scenario -A scenario file is a `js` file that exports functions to provide details about +A scenario file is a `js` file that exports functions providing details about how to navigate to and interact with your page. Now let's copy the following -example and save it as `~/memlab/scenraio.js` file somewhere we can find later. +example and save it as `~/memlab/scenario.js` somewhere we can find later. ```javascript // initial page load's url @@ -56,8 +56,8 @@ It is highly recommended that the web app under test serves unminified code, which makes the retainer trace and symbols in leak report easier to understand. ::: -memlab will lively update a breadcrumb showing the progress of interaction -with the target web page: +memlab will run through the scenario, showing the progress of the interaction +with the target web page as it does so: ```bash page-load(baseline)[s1] > action-on-page(target)[s2] > revert(final)[s3] @@ -81,8 +81,8 @@ A breakdown of each step in the breadcrumb: - **revert(final)** - this is when we perform the back/reverse action. In this example, it is going back to the home page. -Continue [reading here](./guides/01-detached-dom.mdx) on how to debug the +Continue [reading here](./guides/01-detached-dom.mdx) for how to debug the memory leak traces reported by memlab. Click [here](./how-memlab-works.md) if you would like to -learn how memlab detects memory leak. +learn how memlab detects memory leaks.