From 84a9a7dacc32ce9ef2dd697927077ccfaf525693 Mon Sep 17 00:00:00 2001 From: Ronald Langeveld Date: Mon, 23 Oct 2023 10:22:03 +0700 Subject: [PATCH] Updated Admin-X settings readme (#18721) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit no issue - Updated the readme document for AdminX, Settings. --- ### 🤖 Generated by Copilot at 728a9a3 Improved the documentation of the `admin-x-settings` project by updating the `README.md` file. Removed obsolete information and added new testing options. --- apps/admin-x-settings/README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/apps/admin-x-settings/README.md b/apps/admin-x-settings/README.md index 0303b7b94d..2b4bbefc2e 100644 --- a/apps/admin-x-settings/README.md +++ b/apps/admin-x-settings/README.md @@ -1,13 +1,12 @@ # Admin X Settings -Experimental re-write of Ghost Admin Settings in React +Ghost Admin Settings in React ## Development ### Pre-requisites - Run `yarn` in Ghost monorepo root -- Run `yarn` in this directory ### Running the development version @@ -15,7 +14,7 @@ Run `yarn dev` to start the development server to test/develop the settings stan ### Running inside Admin -Run `yarn dev` from the top-level repo with `--adminX` +Run `yarn dev` (like you would run Ghost dev normally) from the top-level repo. AdminX will automatically rebuild when you make changes. ## Develop @@ -30,4 +29,7 @@ Follow the instructions for the top-level repo. ## Test - `yarn lint` run just eslint -- `yarn test` run lint and tests +- `yarn test:acceptance` runs acceptance tests +- `yarn test:unit` runs unit tests +- `yarn test:acceptance path/to/test` runs a specific test +- `yarn test:acceptance:slowmo` runs acceptance tests in slow motion and headed mode, useful for debugging and developing tests