diff --git a/desktop/plugins/public/crash_reporter/docs/overview.mdx b/desktop/plugins/public/crash_reporter/docs/overview.mdx index f6054e055..daffef9d7 100644 --- a/desktop/plugins/public/crash_reporter/docs/overview.mdx +++ b/desktop/plugins/public/crash_reporter/docs/overview.mdx @@ -1,6 +1,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; -The Crash Reporter Plugin shows a notification in Flipper whenever an app crashes. You can click on the notification to see crash information such as stacktrace and other metadata. +The Crash Reporter plugin shows a notification in Flipper whenever an app crashes. You can click on the notification to see crash information such as stacktrace and other metadata. For Android, clicking on the 'Open in Logs' button jumps to the relevant row in the Logs plugin containing the crash information, as shown in the following screenshots. diff --git a/desktop/plugins/public/fresco/docs/overview.mdx b/desktop/plugins/public/fresco/docs/overview.mdx index 71b7bb19f..6b160b36d 100644 --- a/desktop/plugins/public/fresco/docs/overview.mdx +++ b/desktop/plugins/public/fresco/docs/overview.mdx @@ -12,8 +12,8 @@ Images are grouped by the different caching layers they are stored in. The curre ## Attribution -Images can be annotated with attributes that can help to determine the context in which an image was loaded and displayed. You can use that information to filter by a particular surface or only inspect images that are in the critical path of your application, for instance during a cold start. +Images can be annotated with attributes that can help to determine the context in which an image was loaded and displayed. You can use that information to filter by a particular surface or only inspect images that are in the critical path of your application (such as during a cold start). ## Leak Tracking -Dealing with large resources can require special APIs to be used that circumvent usual garbage collection. The plugin allows tracking `CloseableReference`s for Fresco on Android that weren't properly closed, which can help you improve the performance of your app. +Dealing with large resources can require special APIs to be used that circumvent usual garbage collection. The plugin enables the tracking of `CloseableReference`s for Fresco on Android that weren't properly closed, which can help you improve the performance of your app. diff --git a/desktop/plugins/public/layout/docs/overview.mdx b/desktop/plugins/public/layout/docs/overview.mdx index 6a4489ddd..fde245b9f 100644 --- a/desktop/plugins/public/layout/docs/overview.mdx +++ b/desktop/plugins/public/layout/docs/overview.mdx @@ -1,8 +1,6 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; -The Layout Inspector in Flipper is useful for a wide variety of debugging scenarios. - -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 Inspector is useful for a wide variety of debugging scenarios. 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. In addition to Flipper, the Layout tab supports [Litho](https://fblitho.com) and [ComponentKit](https://componentkit.org) components; it integrates with these frameworks to present components in the hierarchy just as if they were native views, exposing all the layout properties, props, and state of the components. The Layout Inspector is further extensible to support other UI frameworks. diff --git a/desktop/plugins/public/logs/docs/overview.mdx b/desktop/plugins/public/logs/docs/overview.mdx index 3fabf0500..c93e207dd 100644 --- a/desktop/plugins/public/logs/docs/overview.mdx +++ b/desktop/plugins/public/logs/docs/overview.mdx @@ -18,6 +18,6 @@ Clicking on a tag, PID or TID in the table filters only for logs with the same v ### Expression Watcher -The Expression Watcher () in the sidebar can be used to 'watch' for certain logs to happen and count how often they occur. An expression can be a simple string, or a regular expression, matched against the logs. +The Expression Watcher in the sidebar can be used to 'watch' for certain logs to happen and count how often they occur. An expression can be a simple string, or a regular expression, matched against the logs. When the notify checkbox is enabled, Flipper sends notifications once the log is being processed. This lets you know when the 'watcher' triggered, even if Flipper is in the background. diff --git a/desktop/plugins/public/navigation/docs/overview.mdx b/desktop/plugins/public/navigation/docs/overview.mdx index 1ce99d050..3aaa1438e 100644 --- a/desktop/plugins/public/navigation/docs/overview.mdx +++ b/desktop/plugins/public/navigation/docs/overview.mdx @@ -1,9 +1,12 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; -The Navigation Plugin enables users to quickly navigate to deep links within their mobile applications to help speed up the development cycle. The plugin is designed to integrate easily within your existing navigation framework or as a standalone tool. Users can bookmark deep links and jump to them via the button in the tool bar, as shown in the following screenshot. +The Navigation Plugin enables users to quickly navigate to deep links within their mobile applications to help speed up the development cycle. The plugin is designed to integrate easily within your existing navigation framework or as a standalone tool. + +Users can bookmark deep links and jump to them via the button in the tool bar, as shown in the following screenshot. Navigation Plugin Button -Navigation events within the app can also be logged to Flipper. This enables the user to view past navigation events and jump straight to them (see the following screenshot) or export the navigation events for reporting. + +Navigation events within the app can also be logged to Flipper, which enables the user to view past navigation events and jump straight to them (see the following screenshot) or export the navigation events for reporting. Navigation Plugin UI diff --git a/docs/features/index.mdx b/docs/features/index.mdx index 54238bd00..4489459f9 100644 --- a/docs/features/index.mdx +++ b/docs/features/index.mdx @@ -1,15 +1,19 @@ --- id: index -title: Features +title: Introduction --- import useBaseUrl from '@docusaurus/useBaseUrl'; -Flipper itself only provides the architectural platform. What makes it useful are the plugins built on top of it: [Logs](plugins/device-logs.mdx), [Layout Inspector](plugins/inspector.mdx) and [Network Inspector](plugins/network.mdx) are all plugins. Plugins can be built very specific to your business logic and the use-cases you have in your app. Flipper is shipped with a couple of built-in all-purpose plugins, but you're encouraged to [build your own](#build-your-own-plugin). Each plugin needs to be enabled individually. +Flipper itself only provides the architectural platform. What makes it useful are the plugins built on top of it, such as [Logs](plugins/device-logs.mdx), [Layout Inspector](plugins/inspector.mdx) and [Network Inspector](plugins/network.mdx). + +Plugins can be tailored to your business logic and the use-cases you have in your app. Flipper is shipped with a couple of built-in all-purpose plugins, but you're encouraged to build your own (see below). Each plugin needs to be enabled individually. Plugins ## Build your own plugin -The Flipper desktop app and the mobile native SDK establish a connection which is used to send data to and from the device. Flipper does not make any restrictions on what kind of data is being sent. This enables a lot of different use-cases where you want to better understand what is going inside your app. For example you can visualize the state of local caches, events happening or trigger actions on your app from the desktop. +The Flipper desktop app and the mobile native SDK establish a connection that is used to send data to and from the device. Flipper does not make any restrictions on what kind of data is being sent. This enables a lot of different use-cases where you want to better understand what is going inside your app. For example, you can visualize the state of local caches, events happening or trigger actions on your app from the desktop. -If there is no plugin that does exactly what you want, then you can build your own plugin tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data. To learn more and build your own plugin, see the [extend Flipper](../tutorial/intro.mdx) page. The native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React. +If there is no plugin that does exactly what you want, you can build your own plugin tailored to your needs. A plugin always consists of the native implementation sending and receiving data and the desktop plugin visualizing data: the native implementations are written in Java, Objective-C, or C++, the desktop UI is written in React. + +To learn more and build your own plugin, see the [Creating Plugins](../tutorial/intro.mdx) section of the Flipper Docs.