diff --git a/docs/extending/architecture.mdx b/docs/extending/architecture.mdx index d955e0fc2..217219409 100644 --- a/docs/extending/architecture.mdx +++ b/docs/extending/architecture.mdx @@ -8,15 +8,22 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; Flipper is built to be a universal pluggable platform for development tools. Currently, Flipper focuses on Android and iOS development, but its design does not limit it to these platforms. Another way to think of Flipper is a more general-purpose implementation of Chrome DevTools. ### Overview -Flipper consists of a desktop interface built with javascript on top of Electron so that it can be packaged to run on any operating system. -This desktop app connects over a [tcp connection](establishing-a-connection.mdx) to applications running on simulators and connected devices. An application running on a device or simulator is what we refer to as a client. +Flipper consists of a desktop interface built with JavaScript on top of Electron so that it can be packaged to run on any operating system. -The connection is bi-directional, allowing the desktop to query information from the client as well as the client to push updates directly to the desktop. +This desktop app connects over a [TCP connection](establishing-a-connection.mdx) to applications running on simulators and connected devices. An application running on a device or simulator is called a 'client'. -By querying data and responding to pushing from the client, a Flipper plugin is able to visualize data, debug problems, and change the behavior of running applications. Flipper provides the platform to build these tools on top of and does not limit what kind of tools that may be. -There are two kinds of plugins in Flipper, client plugins and desktop plugins. Client plugins expose information as an API to desktop plugins whose responsibility it is to render this information in an easy-to-digest way. Client plugins are written once for each platform in the platform's native language. Desktop plugins are written only once in JavaScript using React and consume the APIs exposed by the client plugins. +The connection is bi-directional, allowing the desktop to query information from the client as well allowing the client to push updates directly to the desktop. + +By querying data and responding to pushing from the client, a Flipper plugin is able to visualize data, debug problems, and change the behavior of running applications. Flipper provides the platform to build these tools and does not limit what kind of tools that may be. + +There are two types of plugins in Flipper: + +* **Client plugins** - expose information as an API to desktop plugins whose responsibility it is to render this information in an easy-to-digest way. Client plugins are written once for each platform in the platform's native language. +* **Desktop plugins** - written only once in JavaScript using React and consume the APIs exposed by the client plugins. ### Architecture - React Native -Simplified visualization of Flipper architecture, when used with React Native. + +The following diagram shows a simplified visualization of the Flipper architecture when used with React Native. + Flipper communication diagram diff --git a/website/static/img/flipper-communication-diagram.bak b/website/static/img/flipper-communication-diagram.bak new file mode 100644 index 000000000..7edaa3a56 Binary files /dev/null and b/website/static/img/flipper-communication-diagram.bak differ diff --git a/website/static/img/flipper-communication-diagram.png b/website/static/img/flipper-communication-diagram.png index 7edaa3a56..8c847f93a 100644 Binary files a/website/static/img/flipper-communication-diagram.png and b/website/static/img/flipper-communication-diagram.png differ