From c9fbd343c6cb28876bdaea900f8e35f982d5d765 Mon Sep 17 00:00:00 2001 From: Clement Rey Date: Wed, 16 Oct 2024 15:11:24 +0200 Subject: [PATCH 1/2] clean up reference menu --- docs/content/reference/about.md | 2 +- docs/content/reference/cli.md | 2 +- docs/content/reference/cpp.md | 2 +- docs/content/reference/data-loaders.md | 2 +- docs/content/reference/dataframes.md | 6 ++++++ docs/content/reference/entity-queries.md | 2 +- docs/content/reference/migration.md | 4 ++-- docs/content/reference/npm.md | 2 +- docs/content/reference/python.md | 2 +- docs/content/reference/rust.md | 2 +- docs/content/reference/sdk.md | 5 +++++ .../{sdk-logging-controls.md => sdk/logging-controls.md} | 2 +- .../{sdk-micro-batching.md => sdk/micro-batching.md} | 2 +- .../{sdk-operating-modes.md => sdk/operating-modes.md} | 2 +- docs/content/reference/store-compaction.md | 2 +- docs/content/reference/types.md | 2 +- docs/content/reference/viewer.md | 2 +- 17 files changed, 27 insertions(+), 16 deletions(-) create mode 100644 docs/content/reference/dataframes.md create mode 100644 docs/content/reference/sdk.md rename docs/content/reference/{sdk-logging-controls.md => sdk/logging-controls.md} (98%) rename docs/content/reference/{sdk-micro-batching.md => sdk/micro-batching.md} (97%) rename docs/content/reference/{sdk-operating-modes.md => sdk/operating-modes.md} (99%) diff --git a/docs/content/reference/about.md b/docs/content/reference/about.md index 7b48f5d688e5..994909c81622 100644 --- a/docs/content/reference/about.md +++ b/docs/content/reference/about.md @@ -1,6 +1,6 @@ --- title: About -order: 100 +order: 1100 --- To learn more about Rerun, the company, visit our Website at [https://www.rerun.io/](https://www.rerun.io/). diff --git a/docs/content/reference/cli.md b/docs/content/reference/cli.md index d7e444914360..ecbffd7d36c9 100644 --- a/docs/content/reference/cli.md +++ b/docs/content/reference/cli.md @@ -1,6 +1,6 @@ --- title: CLI manual -order: 250 +order: 0 --- ## rerun diff --git a/docs/content/reference/cpp.md b/docs/content/reference/cpp.md index 9d61b17b6783..268215790386 100644 --- a/docs/content/reference/cpp.md +++ b/docs/content/reference/cpp.md @@ -1,5 +1,5 @@ --- title: 🌊 C++ APIs -order: 1000 +order: 2000 redirect: https://ref.rerun.io/docs/cpp --- diff --git a/docs/content/reference/data-loaders.md b/docs/content/reference/data-loaders.md index 680061c51967..085aad735444 100644 --- a/docs/content/reference/data-loaders.md +++ b/docs/content/reference/data-loaders.md @@ -1,5 +1,5 @@ --- title: Data-loaders -order: 550 +order: 800 redirect: reference/data-loaders/overview --- diff --git a/docs/content/reference/dataframes.md b/docs/content/reference/dataframes.md new file mode 100644 index 000000000000..ed8bb533a69a --- /dev/null +++ b/docs/content/reference/dataframes.md @@ -0,0 +1,6 @@ +--- +title: Dataframes +order: 300 +--- + +Incoming. diff --git a/docs/content/reference/entity-queries.md b/docs/content/reference/entity-queries.md index 958858d84542..dfaf0f0f0c1c 100644 --- a/docs/content/reference/entity-queries.md +++ b/docs/content/reference/entity-queries.md @@ -1,6 +1,6 @@ --- title: Entity Queries -order: 500 +order: 100 --- Many space views are made up of visualizations that include more than one diff --git a/docs/content/reference/migration.md b/docs/content/reference/migration.md index d5699be8c269..ab7c954aa6fe 100644 --- a/docs/content/reference/migration.md +++ b/docs/content/reference/migration.md @@ -1,5 +1,5 @@ --- title: Migration Guides -order: 900 -redirect: reference/migration/migration-0-17 +order: 1000 +redirect: reference/migration/migration-0-18 --- diff --git a/docs/content/reference/npm.md b/docs/content/reference/npm.md index 19f2ceddb385..0f3c9624b17a 100644 --- a/docs/content/reference/npm.md +++ b/docs/content/reference/npm.md @@ -1,5 +1,5 @@ --- title: 💻 Web Viewer API -order: 1400 +order: 2400 redirect: https://npmjs.com/package/@rerun-io/web-viewer --- diff --git a/docs/content/reference/python.md b/docs/content/reference/python.md index 6123dd0ba701..151ebd0a1561 100644 --- a/docs/content/reference/python.md +++ b/docs/content/reference/python.md @@ -1,5 +1,5 @@ --- title: 🐍 Python APIs -order: 1100 +order: 2100 redirect: https://ref.rerun.io/docs/python --- diff --git a/docs/content/reference/rust.md b/docs/content/reference/rust.md index cc1623a5165b..16ec9e4d616f 100644 --- a/docs/content/reference/rust.md +++ b/docs/content/reference/rust.md @@ -1,5 +1,5 @@ --- title: 🦀 Rust APIs -order: 1200 +order: 2200 redirect: https://docs.rs/rerun/ --- diff --git a/docs/content/reference/sdk.md b/docs/content/reference/sdk.md new file mode 100644 index 000000000000..7af73a1f76c8 --- /dev/null +++ b/docs/content/reference/sdk.md @@ -0,0 +1,5 @@ +--- +title: SDK configuration +order: 700 +redirect: reference/sdk/logging-controls +--- diff --git a/docs/content/reference/sdk-logging-controls.md b/docs/content/reference/sdk/logging-controls.md similarity index 98% rename from docs/content/reference/sdk-logging-controls.md rename to docs/content/reference/sdk/logging-controls.md index 32df08f1c69b..3e7ca87a28f7 100644 --- a/docs/content/reference/sdk-logging-controls.md +++ b/docs/content/reference/sdk/logging-controls.md @@ -1,5 +1,5 @@ --- -title: SDK Logging Controls +title: Logging Controls order: 600 --- diff --git a/docs/content/reference/sdk-micro-batching.md b/docs/content/reference/sdk/micro-batching.md similarity index 97% rename from docs/content/reference/sdk-micro-batching.md rename to docs/content/reference/sdk/micro-batching.md index f53802a05469..5c2f1e5c1d86 100644 --- a/docs/content/reference/sdk-micro-batching.md +++ b/docs/content/reference/sdk/micro-batching.md @@ -1,5 +1,5 @@ --- -title: SDK Micro Batching +title: Micro Batching order: 700 --- diff --git a/docs/content/reference/sdk-operating-modes.md b/docs/content/reference/sdk/operating-modes.md similarity index 99% rename from docs/content/reference/sdk-operating-modes.md rename to docs/content/reference/sdk/operating-modes.md index f129b4059a4e..2606a9f13027 100644 --- a/docs/content/reference/sdk-operating-modes.md +++ b/docs/content/reference/sdk/operating-modes.md @@ -1,5 +1,5 @@ --- -title: SDK Operating Modes +title: Operating Modes order: 800 --- diff --git a/docs/content/reference/store-compaction.md b/docs/content/reference/store-compaction.md index b5bfc5c7a836..99fdb853895b 100644 --- a/docs/content/reference/store-compaction.md +++ b/docs/content/reference/store-compaction.md @@ -1,6 +1,6 @@ --- title: Datastore compaction -order: 850 +order: 900 --- diff --git a/docs/content/reference/types.md b/docs/content/reference/types.md index b2b7dd6cd3f6..8ec018bec8be 100644 --- a/docs/content/reference/types.md +++ b/docs/content/reference/types.md @@ -1,6 +1,6 @@ --- title: Types -order: 400 +order: 600 --- Rerun has 3 levels of types that can be used in all SDK languages: diff --git a/docs/content/reference/viewer.md b/docs/content/reference/viewer.md index b8a014bdb5e2..a6f967afff4a 100644 --- a/docs/content/reference/viewer.md +++ b/docs/content/reference/viewer.md @@ -1,5 +1,5 @@ --- title: Viewer -order: 300 +order: 500 redirect: reference/viewer/overview --- From 5c075ee6d78c6c6b7629b8591a7932c7f6d42e96 Mon Sep 17 00:00:00 2001 From: Clement Rey Date: Wed, 16 Oct 2024 15:16:48 +0200 Subject: [PATCH 2/2] where else though? --- docs/content/reference/video.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/content/reference/video.md b/docs/content/reference/video.md index 544072b3ac54..3063324385be 100644 --- a/docs/content/reference/video.md +++ b/docs/content/reference/video.md @@ -1,5 +1,5 @@ --- -title: Video in Rerun +title: Video order: 400 ---