Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The easiest way to launch the Viewer is directly from the logging API with `rr.i
#### Web viewer
You can try running the Viewer in a browser using `rr.serve()` in Python, or using `rerun --web-viewer mydata.rrd`.

The web viewer consists of just a few small files - a thin `.html`, a `.wasm` blob, and an auto-generated `.js` bridge for the wasm. These files are served using the [`re_web_viewer_server`](https://github.com/rerun-io/rerun/tree/latest/crates/re_web_viewer_server) crate.
The web viewer consists of just a few small files - a thin `.html`, a `.wasm` blob, and an auto-generated `.js` bridge for the wasm. These files are served using the [`re_web_viewer_server`](https://github.com/rerun-io/rerun/tree/latest/crates/viewer/re_web_viewer_server) crate.

The web viewer can load `.rrd` files (just drag-drop them into the browser), or read logging data streamed over WebSockets.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ namespace rerun.components;
/// blueprints.
struct ShowLabels (
"attr.arrow.transparent",
"attr.docs.unreleased",
"attr.python.aliases": "bool",
"attr.python.array_aliases": "bool, npt.NDArray[np.bool_]",
"attr.rust.derive": "Copy, PartialEq, Eq",
Expand Down
2 changes: 1 addition & 1 deletion crates/store/re_types_core/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ pub const DEFAULT_DISPLAY_DECIMALS: usize = 3;
///
/// Have a look at our [Custom Data Loader] example to learn more about handwritten bundles.
///
/// [IDL definitions]: https://github.com/rerun-io/rerun/tree/latest/crates/re_types/definitions/rerun
/// [IDL definitions]: https://github.com/rerun-io/rerun/tree/latest/crates/store/re_types/definitions/rerun
/// [Custom Data Loader]: https://github.com/rerun-io/rerun/blob/latest/examples/rust/custom_data_loader
pub trait AsComponents {
/// Exposes the object's contents as a set of [`ComponentBatch`]s.
Expand Down
2 changes: 1 addition & 1 deletion docs/content/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,4 @@ Guides for using Rerun in more advanced ways.
- [Extend Rerun](howto/extend)
- [By logging custom data](howto/extend/custom-data.md)
- [By implementing custom visualizations (Rust only)](howto/extend/extend-ui.md)
- [Efficiently log time series data using `send_columns`](howto/send_columns)
- [Efficiently log time series data using `send_columns`](howto/send_columns.md)
2 changes: 1 addition & 1 deletion docs/content/reference/sdk-micro-batching.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Rerun SDK automatically handles micro-batching in a background thread in ord

The flushing is triggered by both time and space thresholds, whichever happens to trigger first.

This is very similar to, and has many parallels with, the [compaction mechanism running on the datastore side](./store-compaction).
This is very similar to, and has many parallels with, the [compaction mechanism running on the datastore side](./store-compaction.md).

You can configure these thresholds using the following environment variables:

Expand Down
2 changes: 1 addition & 1 deletion docs/content/reference/store-compaction.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ The Rerun datastore continuously compacts data as it comes in, in order find a s

The compaction is triggered by both number of rows and number of bytes thresholds, whichever happens to trigger first.

This is very similar to, and has many parallels with, the [micro-batching mechanism running on the SDK side](./sdk-micro-batching).
This is very similar to, and has many parallels with, the [micro-batching mechanism running on the SDK side](./sdk-micro-batching.md).

You can configure these thresholds using the following environment variables:

Expand Down
6 changes: 3 additions & 3 deletions docs/content/reference/types/components/show_labels.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/content/reference/types/datatypes/bool.md

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion examples/cpp/external_data_loader/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ This is an example executable data-loader plugin for the Rerun Viewer.
It will log C++ source code files as markdown documents.
To try it out, compile it and place it in your $PATH, then open a C++ source file with Rerun (`rerun file.cpp`).

Consider using the [`send_columns`](https://ref.rerun.io/docs/cpp/stable/classrerun_1_1_recording_stream.html#a4d8c152606ea11043b379b9baec2c6ae) API for data loaders that ingest time series data from a file.
Consider using the [`send_columns`](https://ref.rerun.io/docs/cpp/stable/classrerun_1_1RecordingStream.html#ad17571d51185ce2fc2fc2f5c3070ad65) API for data loaders that ingest time series data from a file.
This can be much more efficient that the stateful `log` API as it allows bundling
component data over time into a single call consuming a continuous block of memory.
2 changes: 1 addition & 1 deletion examples/rust/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Rerun Rust examples

These are examples of how to use the [`rerun`](https://github.com/rerun-io/rerun/tree/latest/crates/rerun) crate.
These are examples of how to use the [`rerun`](https://github.com/rerun-io/rerun/tree/latest/crates/top/rerun) crate.

## Running the examples

Expand Down
4 changes: 2 additions & 2 deletions rerun_cpp/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ From a build system perspective, the SDK consists of three dependencies:
* To avoid compatibility issues across different platforms, compiler versions and C++ standard library versions
we recommend to build the C++ SDK directly from source.
Note that this also what happens when you follow the CMake setup in the [quickstart guide](https://www.rerun.io/docs/getting-started/quick-start/cpp).
* [rerun_c](https://github.com/rerun-io/rerun/tree/latest/crates/rerun_c/) static libraries
* [rerun_c](https://github.com/rerun-io/rerun/tree/latest/crates/top/rerun_c/) static libraries
* Rerun C is a minimal C SDK and forms the bridge to the shared Rust codebase
* Due to the rigidity of the C ABI and lack of complex standard library types in the interface,
compatibility issues between compilers are less of a concern
Expand Down Expand Up @@ -143,7 +143,7 @@ target_link_libraries(<yourtarget> PRIVATE rerun_sdk)

Refer to the [build instruction](https://github.com/rerun-io/rerun/tree/latest/BUILD.md) at the repo root.

Keep in mind that all archetypes/components/datatypes are mostly generated by the [Rerun types builder](https://github.com/rerun-io/rerun/tree/latest/crates/re_types_builder).
Keep in mind that all archetypes/components/datatypes are mostly generated by the [Rerun types builder](https://github.com/rerun-io/rerun/tree/latest/crates/build/re_types_builder).
Use `pixi run codegen` to run code generation. Generally, all generated code files are part of the repository,
so you only have to do that if you change the data definition or make changes to `_ext.cpp` files which
extend generated types.
Expand Down
2 changes: 1 addition & 1 deletion rerun_cpp/cmake_setup_in_detail.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ to pick up a system-version of Arrow instead of the one you built against.
## RERUN_C_LIB
Path to the static Rerun C library to link against.

`rerun_c` is a static library built from a [Rust crate](https://github.com/rerun-io/rerun/tree/latest/crates/rerun_c).
`rerun_c` is a static library built from a [Rust crate](https://github.com/rerun-io/rerun/tree/latest/crates/top/rerun_c).
It provides a minimalistic C interface that encapsulates the shared building blocks of all Rerun SDKs.

By default points to where a pre-built library for the currently active platform
Expand Down
2 changes: 1 addition & 1 deletion scripts/lint.py
Original file line number Diff line number Diff line change
Expand Up @@ -1179,7 +1179,7 @@ def main() -> None:
"./.github/workflows/reusable_checks.yml", # zombie TODO hunting job
"./.pytest_cache",
"./CODE_STYLE.md",
"./crates/re_types_builder/src/reflection.rs", # auto-generated
"./crates/build/re_types_builder/src/reflection.rs", # auto-generated
"./docs/content/reference/cli.md", # auto-generated
"./examples/assets",
"./examples/python/detect_and_track_objects/cache/version.txt",
Expand Down