From 0e920e85586ae9b9b78acf2511246b93e8d25204 Mon Sep 17 00:00:00 2001 From: Anton Nikolaev Date: Mon, 16 Mar 2020 03:25:45 -0700 Subject: [PATCH] Few fixes in docs after folders re-arrangements Summary: Few fixes in docs after folders re-arrangements Reviewed By: mweststrate Differential Revision: D20465905 fbshipit-source-id: f65a154731a9956cd0cb6ab66a42eaeecaaf8af0 --- README.md | 4 ++-- docs/extending/debugging.md | 2 +- docs/extending/jssetup.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index dfedf728f..e549f1673 100644 --- a/README.md +++ b/README.md @@ -66,7 +66,7 @@ Please refer to our [Getting Started guide](https://fbflipper.com/docs/getting-s ``` git clone https://github.com/facebook/flipper.git -cd flipper +cd flipper/desktop yarn yarn start ``` @@ -119,7 +119,7 @@ Alternatively, the app can be started on `iOS` by running `yarn ios`. Older yarn versions might show an error / hang with the message 'Waiting for the other yarn instance to finish'. If that happens, run the command `yarn` first separately in the directory `react-native/react-native-flipper`. -## Documentation +# Documentation Find the full documentation for this project at [fbflipper.com](https://fbflipper.com/docs). diff --git a/docs/extending/debugging.md b/docs/extending/debugging.md index 0c58e45eb..444f78910 100644 --- a/docs/extending/debugging.md +++ b/docs/extending/debugging.md @@ -21,7 +21,7 @@ To attach the running Flipper instance open new tab in Google Chrome, navigate t ## Visual Studio Code -If you prefer to use the same editor for both coding and debugging, you can attach to the running Flipper instance for debugging right from Visual Studio Code. First of all, you need to install extension "Debugger for Chrome". Then, to start debugging, open the root folder of Flipper repository in VSCode, execute `yarn start` in terminal to launch Flipper in development mode, select tab `Debug and Run`, and run task `Attach to Running Renderer`. By default this task is set as the first one, so you can just press `F5` to run it. +If you prefer to use the same editor for both coding and debugging, you can attach to the running Flipper instance for debugging right from Visual Studio Code. First of all, you need to install extension "Debugger for Chrome". Then, to start debugging, open folder `desktop` of Flipper repository in VSCode, execute `yarn start` in terminal to launch Flipper in development mode, select tab `Debug and Run`, and run task `Attach to Running Renderer`. By default this task is set as the first one, so you can just press `F5` to run it. ![Attach From Visual Studio Code](/docs/assets/debugging-from-vscode.png) diff --git a/docs/extending/jssetup.md b/docs/extending/jssetup.md index 301ddc53b..4173d9108 100644 --- a/docs/extending/jssetup.md +++ b/docs/extending/jssetup.md @@ -91,7 +91,7 @@ Make sure you have a recent version of node.js and yarn installed on your system ``` git clone https://github.com/facebook/flipper.git -cd flipper +cd flipper/desktop yarn yarn start ```