Merge pull request #5 from GuardianUI/jem-review-2

Feedback

Author: lipmaneth

README.md

@@ -1,12 +1,16 @@
 # GuardianUI Overview
 
-[GuardianUI](https://www.guardianui.com/) is an end-to-end testing and monitoring platform for web3 apps. We offer a suite of products designed to improve frontend security and UX in the crypto space, including our open source testing framework - [GuardianTest](platform/readme/).
+[GuardianUI](https://www.guardianui.com/) is an end-to-end testing and monitoring platform for web3 apps. We offer a suite of products designed to improve frontend security and UX in the crypto space, including our open source testing framework - [GuardianTest](platform/guardian-test/).
+
+## Mission
+
+Our mission is simple. We aim to make it easy for web3 developers to create reliable, robust, and safe applications for users. We are currently focused on improving E2E testing and monitoring.
 
 ## GuardianUI Ecosystem
 
-### [GuardianTest](platform/readme/)
+### [GuardianTest](platform/guardian-test/)
 
-The GuardianUI Test framework ("GuardianTest") is an open source E2E testing framework developed to suit the demands of crypto organizations and developers.
+The GuardianUI Test framework ("GuardianTest") is an open source E2E testing framework developed to suit the demands of crypto projects and developers.
 
 It extends the popular [Playwright](https://playwright.dev/) testing framework so developers can easily:
 
@@ -24,12 +28,8 @@ Our monitoring system lets users run their tests written with the GuardianTest f
 
 Learn more about our monitoring product and the frontend exploits it can help detect [here](https://www.guardianui.com/).
 
-### [StoryCheck](platform/storycheck-beta.md)
+### [StoryCheck (BETA)](platform/storycheck-beta.md)
 
 StoryCheck is a system designed to drastically reduce the difficulty of writing end-to-end tests and aims to make it a process non-developers can also participate in. At its core, it converts text into automatically executed test code. It does so by taking markdown formatted user stories with steps written in natural language as input. Then it parses the text and executes steps in a virtual web browser (via Playwright) closely emulating the actions of a real user. It uses [RefExp GPT](https://huggingface.co/spaces/GuardianUI/ui-refexp-click) to predict UI element coordinates given a referring expression.
 
 Learn more about StoryCheck and how you can integrate it into your testing workflow [here](https://github.com/GuardianUI/storycheck).
-
-## Mission
-
-Our mission is simple. We aim to make it easy for web3 developers to create reliable, robust, and safe applications for users. We are currently focused on improving E2E testing and monitoring.

SUMMARY.md

@@ -6,35 +6,35 @@
 
 ## Platform
 
-* [GuardianTest](platform/readme/GuardianTest.md)
-  * [Overview](platform/readme/overview/README.md)
-    * [Key Benefits](platform/readme/overview/key-benefits.md)
-    * [Framework Roadmap](platform/readme/overview/framework-roadmap.md)
-    * [Supported Chains](platform/readme/overview/supported-chains.md)
-    * [End-to-End Testing Overview](platform/readme/overview/end-to-end-testing-overview.md)
-  * [Getting Started](platform/readme/getting-started/README.md)
-    * [Installation](platform/readme/getting-started/installation.md)
-    * [Writing Tests](platform/readme/getting-started/writing-your-first-e2e-test.md)
-    * [Running Tests](platform/readme/getting-started/running-tests.md)
-    * [Test Examples](platform/readme/getting-started/test-examples.md)
-  * [API](platform/readme/api/README.md)
-    * [GUI](platform/readme/api/gui.md)
-    * [Playwright](platform/readme/api/playwright.md)
-  * [Integrations](platform/readme/integrations/README.md)
-    * [CI/CD Integrations](platform/readme/integrations/ci-cd-integrations.md)
-    * [Monitoring Integrations](platform/readme/integrations/monitoring-integrations.md)
-  * [Guides](platform/readme/guides/README.md)
-    * [Actions](platform/readme/guides/actions.md)
-    * [Mocking APIs](platform/readme/guides/mocking-apis.md)
-    * [Mocking Subgraph](platform/readme/guides/mocking-subgraph.md)
-    * [Screenshots](platform/readme/guides/screenshots.md)
+* [GuardianTest](platform/guardian-test/GuardianTest.md)
+  * [Overview](platform/guardian-test/overview/README.md)
+    * [Key Benefits](platform/guardian-test/overview/key-benefits.md)
+    * [Framework Roadmap](platform/guardian-test/overview/framework-roadmap.md)
+    * [Supported Chains](platform/guardian-test/overview/supported-chains.md)
+    * [End-to-End Testing Overview](platform/guardian-test/overview/end-to-end-testing-overview.md)
+  * [Getting Started](platform/guardian-test/getting-started/README.md)
+    * [Installation](platform/guardian-test/getting-started/installation.md)
+    * [Writing Tests](platform/guardian-test/getting-started/writing-your-first-e2e-test.md)
+    * [Running Tests](platform/guardian-test/getting-started/running-tests.md)
+    * [Test Examples](platform/guardian-test/getting-started/test-examples.md)
+  * [API](platform/guardian-test/api/README.md)
+    * [GUI](platform/guardian-test/api/gui.md)
+    * [Playwright](platform/guardian-test/api/playwright.md)
+  * [Integrations](platform/guardian-test/integrations/README.md)
+    * [CI/CD Integrations](platform/guardian-test/integrations/ci-cd-integrations.md)
+    * [Monitoring Integrations](platform/guardian-test/integrations/monitoring-integrations.md)
+  * [Guides](platform/guardian-test/guides/README.md)
+    * [Actions](platform/guardian-test/guides/actions.md)
+    * [Mocking APIs](platform/guardian-test/guides/mocking-apis.md)
+    * [Mocking Subgraph](platform/guardian-test/guides/mocking-subgraph.md)
+    * [Screenshots](platform/guardian-test/guides/screenshots.md)
 * [Continuous Monitoring](platform/continuous-monitoring/README.md)
   * [Monitoring](platform/continuous-monitoring/monitoring/README.md)
     * [How We Run Checks](platform/continuous-monitoring/monitoring/how-we-run-checks.md)
     * [Check Results](platform/continuous-monitoring/monitoring/check-results.md)
     * [How We Store Data](platform/continuous-monitoring/monitoring/how-we-store-data.md)
   * [Browser Checks](platform/continuous-monitoring/browser-checks/README.md)
-    * [Writing Tests](platform/readme/getting-started/writing-your-first-e2e-test.md)
+    * [Writing Tests](platform/guardian-test/getting-started/writing-your-first-e2e-test.md)
     * [Request Custom Test Writing](platform/continuous-monitoring/browser-checks/request-custom-test-writing.md)
     * [Submitting Tests for Monitoring](platform/continuous-monitoring/browser-checks/submitting-tests-for-monitoring.md)
   * [Alerts](platform/continuous-monitoring/alerts/README.md)

platform/continuous-monitoring/browser-checks/README.md

@@ -18,9 +18,9 @@ Your browser checks should verify:
 
 The combination of automated interactions and assertions leads to confidence that your app works as expected.
 
-GuardianUI's monitoring system uses tests written in [GuardianTest](https://app.gitbook.com/o/aEzOvP1ODgbzLwqZ2irE/s/6blK04TyOYOkA5ZEQW4b/\~/changes/15/platform/readme), a custom modification to the popular [Playwright](https://github.com/microsoft/playwright) framework, to power your browser checks. 
+GuardianUI's monitoring system uses tests written in [GuardianTest](/platform/guardian-test/), a custom modification to the popular [Playwright](https://github.com/microsoft/playwright) framework, to power your browser checks. 
 
-For examples of valid browser checks and instructions for how to create them, see [Writing Tests](broken-reference) and [Test Examples](../../readme/getting-started/test-examples.md).
+For examples of valid browser checks and instructions for how to create them, see [Writing Tests](/platform/guardian-test/getting-started/writing-your-first-e2e-test/) and [Test Examples](/platform/guardian-test/getting-started/test-examples/.
 
 {% hint style="info" %}
 Valid GuardianTest scripts are the foundation of a valid browser check. If the script passes, your check passes. If the script fails, your check fails.

platform/readme/GuardianTest.md renamed to platform/guardian-test/README.md

@@ -7,7 +7,7 @@ description: >-
 
 # GuardianTest
 
-GuardianTest is an open source E2E testing framework developed to suit the demands of crypto organizations and developers.
+GuardianTest is an [open source](https://github.com/GuardianUI/GuardianTest) E2E testing framework developed to suit the demands of crypto projects and developers.
 
 It extends the popular [Playwright](https://playwright.dev/) testing framework so developers can easily:
 
@@ -18,4 +18,3 @@ It extends the popular [Playwright](https://playwright.dev/) testing framework s
 * Mock ERC20 balances and allowances
 * Validate target contract addresses from app interactions
 * Perform any other actions or validation Playwright offers
-

platform/readme/api/README.md renamed to platform/guardian-test/api/README.md

@@ -2,12 +2,12 @@
 
 ## Dependencies
 
-### Installing Node.js
+### Node.js
 
 * Check if you already have Node installed by opening a terminal or command prompt instance and executing `node -v`. You should see a version number in the return.
 * If you do not have Node already installed, go to [Node.js](https://nodejs.org/en/download) and select the version associated with your operating system.
 
-### Installing Foundry
+### Foundry
 
 Check if you already have [Anvil](https://github.com/foundry-rs/foundry/tree/master/anvil) installed through Foundry by opening a terminal or command prompt instance and executing `anvil -V`. You should see a version number in the return. If you do not, follow one of the guides below.
 
@@ -19,29 +19,27 @@ Check if you already have [Anvil](https://github.com/foundry-rs/foundry/tree/mas
 * **CI**
   * [Installation for CI](https://book.getfoundry.sh/getting-started/installation#installing-for-ci-in-github-action)
 
-## Installing GuardianTest
+### GuardianTest
 
 You can install GuardianTest using either npm or yarn:
 
-**npm**
+#### NPM
 
-`npm install @guardianui/test`
+`npm install --save-dev @guardianui/test`
 
-**yarn**
+#### Yarn
 
-`yarn add @guardianui/test`
+`yarn add --dev @guardianui/test`
 
-## Installing Playwright Browsers
+### Playwright Browsers
 
 `npx playwright install`
 
-
-
 ## Configuring the Framework
 
 ### Playwright Config
 
-At your repo's top-level directory create a file called `playwright.config.ts`
+At your repo's top-level directory create a file called `playwright.config.ts`.
 
 If you already are using Playwright and already have a `playwright.config.ts`, just add `/.*gui\.(js|ts|mjs)/` to the `testMatch` entry to make sure Playwright recognizes our tests.
 
@@ -155,20 +153,16 @@ const config: PlaywrightTestConfig = {
 export default config;
 ```
 
-
-
 ### env
 
 At your repo's top-level directory create another file called `.env` or if you already have one add the following to your existing `.env`. Comment out whichever line you do not use with a `#` at the start.
 
-```
+```bash
 # Must fill in one of these API keys, do not need both
 GUARDIAN_UI_INFURA_API_KEY=
 GUARDIAN_UI_ALCHEMY_API_KEY=
 ```
 
-
-
 ### package.json
 
 To be able to run tests, add the following to your app's `package.json` scripts section:
@@ -177,8 +171,6 @@ To be able to run tests, add the following to your app's `package.json` scripts
 "test:gui": "npx playwright test --project=chromium --headed"
 ```
 
-
-
 ### Tests Folder
 
-Create a folder called `tests` to house your GuardianTest tests in
+Create a folder called `tests` to house your GuardianTest tests in.