From 09c6472079f79309d91c07f094d357a921bfe088 Mon Sep 17 00:00:00 2001 From: Jeremy Leibs Date: Thu, 17 Oct 2024 09:10:10 -0400 Subject: [PATCH] Fix doc links from cleanup in #7776 --- CHANGELOG.md | 8 ++++---- crates/top/re_sdk/src/recording_stream.rs | 8 ++++---- crates/top/rerun/src/lib.rs | 2 +- .../re_viewer/data/quick_start_guides/how_does_it_work.md | 2 +- docs/content/howto/embed-rerun-viewer.md | 2 +- docs/content/reference/data-loaders/overview.md | 2 +- rerun_cpp/src/rerun/recording_stream.hpp | 2 +- rerun_js/web-viewer-react/README.md | 2 +- rerun_js/web-viewer/README.md | 2 +- rerun_py/docs/gen_common_index.py | 2 +- 10 files changed, 16 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d672a4bad706..98c896927f89 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -262,7 +262,7 @@ API usage examples: The Rerun datastore now continuously compacts data as it comes in, in order find a sweet spot between ingestion speed, query performance and memory overhead. -This is very similar to, and has many parallels with, the [micro-batching mechanism running on the SDK side](https://rerun.io/docs/reference/sdk-micro-batching). +This is very similar to, and has many parallels with, the [micro-batching mechanism running on the SDK side](https://rerun.io/docs/reference/sdk/micro-batching). You can read more about this in the [dedicated documentation entry](https://rerun.io/docs/reference/store-compaction). @@ -1961,7 +1961,7 @@ Other highlights: - This can be used as an alternative to the previous `MsgSender::with_time` APIs. - The Rerun SDK now defaults to 8ms long microbatches instead of 50ms. This makes the default behavior more suitable for use-cases like real-time video feeds. [#2220](https://github.com/rerun-io/rerun/pull/2220) - - Check out [the microbatching docs](https://www.rerun.io/docs/reference/sdk-micro-batching) for more information + - Check out [the microbatching docs](https://www.rerun.io/docs/reference/sdk/micro-batching) for more information on fine-tuning the micro-batching behavior. - The web viewer now incremental loads `.rrd` files when streaming over HTTP. [#2412](https://github.com/rerun-io/rerun/pull/2412) @@ -2292,7 +2292,7 @@ here's a smaller release packed with useful improvements 🎉 - ⚠️ BREAKING: You must now call `rr.init` if you want logging to work. - ⚠️ BREAKING: `set_enabled` has been removed. In order to disable logging at runtime, call `set_global_data_recording(None)`. - See also [the doc section on this topic](https://www.rerun.io/docs/reference/sdk-logging-controls#dynamically-turn-logging-onoff). + See also [the doc section on this topic](https://www.rerun.io/docs/reference/sdk/logging-controls#dynamically-turn-logging-onoff). - `log_mesh_file`: accept either path or bytes [#2098](https://github.com/rerun-io/rerun/pull/2098) - Add `draw_order` to 2D primitives [#2138](https://github.com/rerun-io/rerun/pull/2138) - Add `rr.version()` [#2084](https://github.com/rerun-io/rerun/pull/2084) @@ -2305,7 +2305,7 @@ here's a smaller release packed with useful improvements 🎉 #### 🦀 Rust SDK - ⚠️ BREAKING: `set_enabled` has been removed. In order to disable logging at runtime, create a no-op recording via `RecordingStream::disabled()`. - See also [the doc section on this topic](https://www.rerun.io/docs/reference/sdk-logging-controls#dynamically-turn-logging-onoff). + See also [the doc section on this topic](https://www.rerun.io/docs/reference/sdk/logging-controls#dynamically-turn-logging-onoff). - ⚠️ BREAKING: `Session` has been replaced by `RecordingStream` [#1983](https://github.com/rerun-io/rerun/pull/1983) - ⚠️ BREAKING: `native_viewer` is now an opt-in feature of the `rerun` library [#2064](https://github.com/rerun-io/rerun/pull/2064) - Rust SDK: bring back support for implicit splats [#2059](https://github.com/rerun-io/rerun/pull/2059) diff --git a/crates/top/re_sdk/src/recording_stream.rs b/crates/top/re_sdk/src/recording_stream.rs index b95a28d52efa..ff1edcc63f54 100644 --- a/crates/top/re_sdk/src/recording_stream.rs +++ b/crates/top/re_sdk/src/recording_stream.rs @@ -883,7 +883,7 @@ impl RecordingStream { /// # Ok::<(), Box>(()) /// ``` /// - /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk-micro-batching + /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk/micro-batching /// [component bundle]: [`AsComponents`] #[inline] pub fn log( @@ -966,7 +966,7 @@ impl RecordingStream { /// /// See also [`Self::log`]. /// - /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk-micro-batching + /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk/micro-batching /// [component bundle]: [`AsComponents`] #[inline] pub fn log_static( @@ -1009,7 +1009,7 @@ impl RecordingStream { /// transport. /// See [SDK Micro Batching] for more information. /// - /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk-micro-batching + /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk/micro-batching /// [component bundle]: [`AsComponents`] #[inline] pub fn log_with_static( @@ -1051,7 +1051,7 @@ impl RecordingStream { /// transport. /// See [SDK Micro Batching] for more information. /// - /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk-micro-batching + /// [SDK Micro Batching]: https://www.rerun.io/docs/reference/sdk/micro-batching pub fn log_component_batches<'a>( &self, ent_path: impl Into, diff --git a/crates/top/rerun/src/lib.rs b/crates/top/rerun/src/lib.rs index 7da6a6a235e0..6cc6e0d6938b 100644 --- a/crates/top/rerun/src/lib.rs +++ b/crates/top/rerun/src/lib.rs @@ -22,7 +22,7 @@ //! trying to achieve and whether the viewer is running in the same process as your code, in //! another process, or even as a separate web application. //! -//! Checkout [SDK Operating Modes](https://www.rerun.io/docs/reference/sdk-operating-modes) for an +//! Checkout [SDK Operating Modes](https://www.rerun.io/docs/reference/sdk/operating-modes) for an //! overview of what's possible and how. //! //! If you get stuck on anything, open an issue at . diff --git a/crates/viewer/re_viewer/data/quick_start_guides/how_does_it_work.md b/crates/viewer/re_viewer/data/quick_start_guides/how_does_it_work.md index c3c51d3ce830..ef9a43f90b95 100644 --- a/crates/viewer/re_viewer/data/quick_start_guides/how_does_it_work.md +++ b/crates/viewer/re_viewer/data/quick_start_guides/how_does_it_work.md @@ -2,7 +2,7 @@ Rerun's goal is to make handling and visualizing multimodal data streams easy and performant. -Rerun is made of two main building blocks: the SDK and the Viewer. The data provided by the user code is serialized by the SDK and transferred (via a log file, a TCP socket, a WebSocket, etc.) to the Viewer process for visualization. You can learn more about Rerun's operating modes [here](https://www.rerun.io/docs/reference/sdk-operating-modes). +Rerun is made of two main building blocks: the SDK and the Viewer. The data provided by the user code is serialized by the SDK and transferred (via a log file, a TCP socket, a WebSocket, etc.) to the Viewer process for visualization. You can learn more about Rerun's operating modes [here](https://www.rerun.io/docs/reference/sdk/operating-modes). In the example above, the SDK connects via a TCP socket to the viewer. diff --git a/docs/content/howto/embed-rerun-viewer.md b/docs/content/howto/embed-rerun-viewer.md index 3d8c461c5fe5..5cefe713703b 100644 --- a/docs/content/howto/embed-rerun-viewer.md +++ b/docs/content/howto/embed-rerun-viewer.md @@ -62,7 +62,7 @@ The first argument for `start` determines the recordings to open in the viewer. - a URL string to open a single recording - an array of strings to open multiple recordings -Each URL can be either a file served over `http` or a connection to an SDK using our [serve](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API. See [web-viewer-serve-example](https://github.com/rerun-io/web-viewer-serve-example) for a full example of how to log data from our Python SDK to an embedded Rerun Viewer. +Each URL can be either a file served over `http` or a connection to an SDK using our [serve](https://www.rerun.io/docs/reference/sdk/operating-modes#serve) API. See [web-viewer-serve-example](https://github.com/rerun-io/web-viewer-serve-example) for a full example of how to log data from our Python SDK to an embedded Rerun Viewer. ### Controlling the canvas diff --git a/docs/content/reference/data-loaders/overview.md b/docs/content/reference/data-loaders/overview.md index 0e01aaf5e3a2..8d99a890be41 100644 --- a/docs/content/reference/data-loaders/overview.md +++ b/docs/content/reference/data-loaders/overview.md @@ -22,7 +22,7 @@ The easiest way to create your own `DataLoader` is by implementing what we call This executable takes a file path as a command line argument and outputs Rerun logs on `stdout`. It will be called by the Rerun Viewer/SDK when the user opens a file, and be passed the path to that file. -From there, it can log data as usual, using the [`stdout` logging sink](../../reference/sdk-operating-modes.md#standard-inputoutput). +From there, it can log data as usual, using the [`stdout` logging sink](../../reference/sdk/operating-modes.md#standard-inputoutput). The Rerun Viewer/SDK will then automatically load the data streamed to the external loader's standard output. diff --git a/rerun_cpp/src/rerun/recording_stream.hpp b/rerun_cpp/src/rerun/recording_stream.hpp index a48731eeacb6..854b561d7487 100644 --- a/rerun_cpp/src/rerun/recording_stream.hpp +++ b/rerun_cpp/src/rerun/recording_stream.hpp @@ -52,7 +52,7 @@ namespace rerun { /// /// Internally, the stream will automatically micro-batch multiple log calls to optimize /// transport. - /// See [SDK Micro Batching](https://www.rerun.io/docs/reference/sdk-micro-batching) for + /// See [SDK Micro Batching](https://www.rerun.io/docs/reference/sdk/micro-batching) for /// more information. /// /// The data will be timestamped automatically based on the `RecordingStream`'s diff --git a/rerun_js/web-viewer-react/README.md b/rerun_js/web-viewer-react/README.md index a63a32958e7b..f80ef5b2bde3 100644 --- a/rerun_js/web-viewer-react/README.md +++ b/rerun_js/web-viewer-react/README.md @@ -36,7 +36,7 @@ export default function App() { The `rrd` in the snippet above should be a URL pointing to either: - A hosted `.rrd` file, such as -- A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API +- A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk/operating-modes#serve) API If `rrd` is not set, the Viewer will display the same welcome screen as . This can be disabled by setting the `hide_welcome_screen` prop to `true`. diff --git a/rerun_js/web-viewer/README.md b/rerun_js/web-viewer/README.md index cfb9adb20f14..4626d05a2bee 100644 --- a/rerun_js/web-viewer/README.md +++ b/rerun_js/web-viewer/README.md @@ -42,7 +42,7 @@ viewer.stop(); The `rrd` in the snippet above should be a URL pointing to either: - A hosted `.rrd` file, such as -- A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk-operating-modes#serve) API +- A WebSocket connection to the SDK opened via the [`serve`](https://www.rerun.io/docs/reference/sdk/operating-modes#serve) API If `rrd` is not set, the Viewer will display the same welcome screen as . This can be disabled by setting `hide_welcome_screen` to `true` in the options object of `viewer.start`. diff --git a/rerun_py/docs/gen_common_index.py b/rerun_py/docs/gen_common_index.py index 6c5aa67ece10..2056f52e673c 100755 --- a/rerun_py/docs/gen_common_index.py +++ b/rerun_py/docs/gen_common_index.py @@ -432,7 +432,7 @@ def make_slug(s: str) -> str: to achieve and whether the viewer is running in the same process as your code, in another process, or even as a separate web application. -Checkout [SDK Operating Modes](https://www.rerun.io/docs/reference/sdk-operating-modes) for an +Checkout [SDK Operating Modes](https://www.rerun.io/docs/reference/sdk/operating-modes) for an overview of what's possible and how. ## APIs