From d3bfeb5bc9085cd912a68c8be8384752617d6e4c Mon Sep 17 00:00:00 2001 From: glopesdev Date: Tue, 3 Jan 2023 20:32:09 +0000 Subject: [PATCH] Reuse overview text for landing page --- docs/articles/intro.md | 8 +------- docs/articles/overview.md | 11 +++++++++++ docs/index.md | 8 ++++++-- 3 files changed, 18 insertions(+), 9 deletions(-) create mode 100644 docs/articles/overview.md diff --git a/docs/articles/intro.md b/docs/articles/intro.md index 65bead3..3a0c047 100644 --- 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. \ No newline at end of file +[!include[Overview](~/articles/overview.md)] \ No newline at end of file diff --git a/docs/articles/overview.md b/docs/articles/overview.md new file mode 100644 index 0000000..f36271d --- /dev/null +++ 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. \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index c3447ea..a9c96fb 100644 --- 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. \ No newline at end of file +[!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**. \ No newline at end of file