Reuse overview text for landing page

bonsai-rx · Jan 5, 2023 · d3bfeb5 · d3bfeb5
1 parent 8f7ad29
commit d3bfeb5
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 9 deletions.
diff --git a/docs/articles/intro.md b/docs/articles/intro.md
@@ -1,9 +1,3 @@
 # Introduction
 
-Bonsai.ZeroMQ is a [Bonsai](https://bonsai-rx.org/) interface for [ZeroMQ](https://zeromq.org/) providing a flexible networking and messaging library for coordinating distributed processing. The core patterns discussed in the [ØMQ Guide](https://zguide.zeromq.org/) are exposed via reactive operators and discussed in detail in the [Patterns](patterns.md) chapter.
-
-You can use Bonsai.ZeroMQ to transmit requests and data across different workflows running in the same computer, or in a different computer. You can also use the package to create endpoints for interfacing Bonsai with other languages supporting ZeroMQ.
-
-## Installing the package
-
-To install Bonsai.ZeroMQ use the Bonsai package manager and search for the **Bonsai - ZeroMQ** package.
+[!include[Overview](~/articles/overview.md)]
diff --git a/docs/articles/overview.md b/docs/articles/overview.md
@@ -0,0 +1,11 @@
+---
+uid: overview
+---
+
+Bonsai.ZeroMQ is a [Bonsai](https://bonsai-rx.org/) interface for [ZeroMQ](https://zeromq.org/) providing a flexible networking and messaging library for coordinating distributed processing. The core patterns discussed in the [ØMQ Guide](https://zguide.zeromq.org/) are exposed via reactive operators and discussed in detail in the [Patterns](patterns.md) chapter.
+
+You can use Bonsai.ZeroMQ to transmit requests and data across different workflows running in the same computer, or in a different computer. You can also use the package to create endpoints for interfacing Bonsai with other languages supporting ZeroMQ.
+
+## Installing the package
+
+To install Bonsai.ZeroMQ use the Bonsai package manager and search for the **Bonsai - ZeroMQ** package.
diff --git a/docs/index.md b/docs/index.md
@@ -1,3 +1,7 @@
-# Bonsai - ZeroMQ
+**Bonsai - ZeroMQ** Documentation
+=================================
 
-Bonsai.ZeroMQ is a [Bonsai](https://bonsai-rx.org/) interface for [ZeroMQ](https://zeromq.org/) allowing real-time asynchronous streaming of messages across multiple transport protocols and connection patterns.
+[!include[Overview](~/articles/overview.md)]
+
+> [!Warning]
+> These docs are under active development, feel free to contribute by either [raising an issue](https://github.com/bonsai-rx/zeromq/issues) or following the links to **Improve this Doc**.