From 79622ac19d44e09ce5ec9571e3263edd3814733d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Daniel=20B=C3=BCchele?= Date: Tue, 30 Apr 2019 09:06:43 -0700 Subject: [PATCH] docs: cross linking from features to setup Summary: linking from feature page to setup instructions. Reviewed By: jknoxville Differential Revision: D15148032 fbshipit-source-id: 66dd2ca07a04d3ac1fb53ad95e91e6d8beb69706 --- docs/features/crash-reporter-plugin.md | 3 +++ docs/features/layout-plugin.md | 2 ++ docs/features/leak-canary-plugin.md | 2 ++ docs/features/network-plugin.md | 2 ++ docs/features/sandbox-plugin.md | 2 ++ docs/features/shared-preferences-plugin.md | 1 + 6 files changed, 12 insertions(+) diff --git a/docs/features/crash-reporter-plugin.md b/docs/features/crash-reporter-plugin.md index 74a3d6326..a1fcee11d 100644 --- a/docs/features/crash-reporter-plugin.md +++ b/docs/features/crash-reporter-plugin.md @@ -3,6 +3,9 @@ id: crash-reporter-plugin title: Crash Reporter --- +→ [See setup instructions for the Crash Reporter](setup/crash-reporter-plugin.md) + + The Crash Reporter Plugin shows a notification in Flipper whenever an app crashes. You can click on the notification to see crash information like stacktrace and other metadata. For Android, you can click the "Open in Logs" button to jump to the row in the Logs plugin with the crash information. ![UI](/docs/assets/crashreporterplugin.png) diff --git a/docs/features/layout-plugin.md b/docs/features/layout-plugin.md index 1d4bb0b1c..cbfad9b15 100644 --- a/docs/features/layout-plugin.md +++ b/docs/features/layout-plugin.md @@ -3,6 +3,8 @@ id: layout-plugin title: Layout Inspector --- +→ [See setup instructions for the Layout Inspector](setup/layout-plugin.md) + The Layout Inspector in Flipper is useful for a ton of different debugging scenarios. First of all, you can inspect what views the hierarchy is made up of as well as what properties each view has. This is incredibly useful when debugging issues with your product. The Layout tab supports [Litho](https://fblitho.com) and [ComponentKit](https://componentkit.org) components as well. We integrate with these frameworks to present components in the hierarchy just as if they were native views. We show you all the layout properties, props, and state of the components. The layout inspector is further extensible to support other UI frameworks. diff --git a/docs/features/leak-canary-plugin.md b/docs/features/leak-canary-plugin.md index d244dd7ed..a4513986e 100644 --- a/docs/features/leak-canary-plugin.md +++ b/docs/features/leak-canary-plugin.md @@ -3,6 +3,8 @@ id: leak-canary-plugin title: LeakCanary --- +→ [See setup instructions for the LeakCanary](setup/leak-canary-plugin.md) + The LeakCanary plugin provides developers with Flipper support for [LeakCanary](https://github.com/square/leakcanary), an open source memory leak detection library. Leaks detected by LeakCanary will appear automatically in Flipper. Each leak will display a hierarchy of objects, beginning from the garbage collector root and ending at the leaked class. diff --git a/docs/features/network-plugin.md b/docs/features/network-plugin.md index 3fd5fd43a..75c75a8d5 100644 --- a/docs/features/network-plugin.md +++ b/docs/features/network-plugin.md @@ -3,6 +3,8 @@ id: network-plugin title: Network --- +→ [See setup instructions for the Network plugin](setup/network-plugin.md) + Use the Network inspector to inspect outgoing network traffic our apps. You can easily browse all requests being made and their responses. The plugin also supports gzipped responses. ![Network plugin](/docs/assets/network.png) diff --git a/docs/features/sandbox-plugin.md b/docs/features/sandbox-plugin.md index 6eea6a961..97280ac0a 100644 --- a/docs/features/sandbox-plugin.md +++ b/docs/features/sandbox-plugin.md @@ -3,5 +3,7 @@ id: sandbox-plugin title: Sandbox --- +→ [See setup instructions for the Sandbox plugin](setup/sandbox-plugin.md) + The Sandbox plugin is useful for developers that had to test changes of their apps by pointing them to some Sandbox environment. Through this plugin and a few lines of code in the client, the app can get a callback and get the value that the user has input through Flipper. At this point, the developer can plugin its logic to save this setting in its app. diff --git a/docs/features/shared-preferences-plugin.md b/docs/features/shared-preferences-plugin.md index f2b62040e..eb06a0c0d 100644 --- a/docs/features/shared-preferences-plugin.md +++ b/docs/features/shared-preferences-plugin.md @@ -2,6 +2,7 @@ id: shared-preferences-plugin title: Shared Preferences --- +→ [See setup instructions for the Shared Preferences plugin](setup/shared-preferences-plugin.md) Easily inspect and modify the data contained within your app's shared preferences.