From f885d7f77343f999f56d84ebdbab22269011bc5f Mon Sep 17 00:00:00 2001 From: Alexandre Arpin Date: Mon, 16 Jun 2025 11:01:59 +0300 Subject: [PATCH] Update mkdocs --- docs/async-await.md | 2 +- docs/poller.md | 2 +- docs/scheduler.md | 0 docs/stream.md | 0 mkdocs.yml | 3 ++- 5 files changed, 4 insertions(+), 3 deletions(-) delete mode 100644 docs/scheduler.md delete mode 100644 docs/stream.md diff --git a/docs/async-await.md b/docs/async-await.md index 719635012..4b7a46529 100644 --- a/docs/async-await.md +++ b/docs/async-await.md @@ -52,7 +52,7 @@ static void Main(string[] args) ``` NetMQRuntime is a wrapper over NetMQPoller, when calling an async function the socket is automatically added to the internal poller. -NetMQRuntime is also a NetMQScheduler and SyncrhonizationContext, so any awaited function is continuing on the runtime's thread. +NetMQRuntime is also a NetMQScheduler and SynchronizationContext, so any awaited function is continuing on the runtime's thread. NetMQSocket should still be used only within one thread. diff --git a/docs/poller.md b/docs/poller.md index c22b0ede4..18d7ed0d7 100644 --- a/docs/poller.md +++ b/docs/poller.md @@ -59,7 +59,7 @@ For ZeroMQ/NetMQ to give great performance, some restrictions exist on how we ca For example, consider socket A with a service loop in thread A, and socket B with a service loop in thread B. It would be invalid to receive a message from socket A (on thread A) and then attempt to send it on socket B. The socket is not threadsafe, and so attempts to use is simultaneously from threads A and B would cause errors. -In fact the pattern described here is known as a [proxy](proxy.md), and one is built into NetMQ. At this point you may not be surprised to learn that it is powered by a `NetMQPoller`. +In fact the pattern described here is known as a proxy, and one is built into NetMQ. At this point you may not be surprised to learn that it is powered by a `NetMQPoller`. ## Example: ReceiveReady diff --git a/docs/scheduler.md b/docs/scheduler.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/docs/stream.md b/docs/stream.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/mkdocs.yml b/mkdocs.yml index efbb33264..6472a9f79 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,6 +1,6 @@ site_name: NetMQ -pages: +nav: - Home: index.md - Introduction: introduction.md - Concepts: @@ -16,6 +16,7 @@ pages: - Timer: timer.md - Queue: queue.md - Proactor: proactor.md + - Devices: devices.md - Patterns: - Request-Response: request-response.md - Pub-Sub: pub-sub.md