Move "What is Rerun for?" to it's own page (rerun-io#5965)

Also includes some copy tweaks. ![Screenshot 2024-04-12 at 15 37 46](https://github.com/rerun-io/rerun/assets/2624717/0f80b16c-a949-4ffb-a800-6a802203f819) --------- Co-authored-by: Clement Rey <[email protected]>
m-decoster · Apr 15, 2024 · e8d39d7 · e8d39d7
1 parent d90ed2f
commit e8d39d7
Show file tree

Hide file tree

Showing 9 changed files with 38 additions and 33 deletions.
diff --git a/.gitignore b/.gitignore
@@ -59,3 +59,5 @@ wheels
 *.rrd
 
 /meilisearch
+
+.pixi/*
diff --git a/docs/content/getting-started/configure-the-viewer.md b/docs/content/getting-started/configure-the-viewer.md
@@ -1,6 +1,6 @@
 ---
 title: Configure the viewer
-order: 5
+order: 600
 ---
 
 By default, the Rerun viewer uses heuristics to automatically determine an appropriate

diff --git a/docs/content/getting-started/data-in.md b/docs/content/getting-started/data-in.md
@@ -1,6 +1,6 @@
 ---
 title: Get data into Rerun
-order: 3
+order: 400
 ---
 
 This section talks about how to get data out of your application into Rerun.

diff --git a/docs/content/getting-started/installing-viewer.md b/docs/content/getting-started/installing-viewer.md
@@ -1,6 +1,6 @@
 ---
 title: Installing Rerun
-order: 2
+order: 300
 ---
 
 ## Installing the SDK

diff --git a/docs/content/getting-started/navigating-the-viewer.md b/docs/content/getting-started/navigating-the-viewer.md
@@ -1,6 +1,6 @@
 ---
 title: Navigating the viewer
-order: 4
+order: 500
 ---
 
 This guide will familiarize you with the basics of using the Rerun Viewer with an example dataset. By the end you should

diff --git a/docs/content/getting-started/quick-start.md b/docs/content/getting-started/quick-start.md
@@ -1,6 +1,6 @@
 ---
 title: Quick start
-order: 1
+order: 200
 ---
 
 Rerun is an SDK and engine for visualizing and interacting with multimodal data

diff --git a/docs/content/getting-started/troubleshooting.md b/docs/content/getting-started/troubleshooting.md
@@ -1,6 +1,6 @@
 ---
 title: Troubleshooting
-order: 5
+order: 600
 ---
 
 You can set `RUST_LOG=debug` before running to get some verbose logging output.

diff --git a/docs/content/getting-started/what-is-rerun-for.md b/docs/content/getting-started/what-is-rerun-for.md
@@ -0,0 +1,30 @@
+---
+title: What is Rerun for?
+order: 100
+---
+
+Rerun is built to help you understand complex processes that include rich multimodal data, like 2D, 3D, text, time series, tensors, etc.
+It is used in many industries, including robotics, simulation, computer vision,
+or anything that involves a lot of sensors or other signals that evolve over time.
+
+### Example use case
+Say you're building a vacuum cleaning robot and it keeps running into walls. Why is it doing that? You need some tool to debug it, but a normal debugger isn't gonna be helpful. Similarly, just logging text won't be very helpful either. The robot may log "Going through doorway" but that won't explain why it thinks the wall is a door.
+
+What you need is a visual and temporal debugger, that can log all the different representations of the world the robots holds in its little head, such as:
+
+* RGB camera feed
+* depth images
+* lidar scan
+* segmentation image (how the robot interprets what it sees)
+* its 3D map of the apartment
+* all the objects the robot has detected (or thinks it has detected), as 3D shapes in the 3D map
+* its confidence in its prediction
+* etc
+
+You also want to see how all these streams of data evolve over time so you can go back and pinpoint exactly what went wrong, when and why.
+
+Maybe it turns out that a glare from the sun hit one of the sensors in the wrong way, confusing the segmentation network leading to bad object detection. Or maybe it was a bug in the lidar scanning code. Or maybe the robot thought it was somewhere else in the apartment, because its odometry was broken. Or it could be one of a thousand other things. Rerun will help you find out!
+
+But seeing the world from the point of the view of the robot is not just for debugging - it will also give you ideas on how to improve the algorithms, new test cases to set up, or datasets to collect. It will also let you explain the brains of the robot to your colleagues, boss, and customers. And so on. Seeing is believing, and an image is worth a thousand words, and multimodal temporal logging is worth a thousand images :)
+
+Of course, Rerun is useful for much more than just robots. Any time you have any form of sensors, or 2D or 3D state evolving over time, Rerun would be a great tool.
diff --git a/docs/content/getting-started/what-is-rerun.md b/docs/content/getting-started/what-is-rerun.md
@@ -38,33 +38,6 @@ That's a big question for a welcome page. The short answer is that
 Rerun goes to extreme lengths to make handling and visualizing
 multimodal data streams easy and performant.
 
-## What is Rerun for?
-Rerun is built to help you understand complex processes that include rich multimodal data, including 2D, 3D, text, time series, tensors, etc.
-It is used in many industries, including robotics, simulation, computer vision, or anything that involves a lot of sensors.
-Let's look at a more concrete example:
-
-### Example use case
-Say you're building a vacuum cleaning robot and it keeps running into walls. Why is it doing that? You need some tool to debug it, but a normal debugger isn't gonna be helpful. Similarly, just logging text won't be very helpful either. The robot may log "Going through doorway" but that won't explain why it thinks the wall is a door.
-
-What you need is a visual and temporal debugger, that can log all the different representations of the world the robots holds in its little head, such as:
-
-* RGB camera feed
-* depth images
-* lidar scan
-* segmentation image (how the robot interprets what it sees)
-* its 3D map of the apartment
-* all the objects the robot has detected (or thinks it has detected), as 3D shapes in the 3D map
-* its confidence in its prediction
-* etc
-
-You also want to see how all these streams of data evolve over time so you can go back and pinpoint exactly what went wrong, when and why.
-
-Maybe it turns out that a glare from the sun hit one of the sensors in the wrong way, confusing the segmentation network leading to bad object detection. Or maybe it was a bug in the lidar scanning code. Or maybe the robot thought it were somewhere else in the apartment, because its odometry was broken. Or it could be one of a thousand other things. Rerun will help you find out!
-
-But seeing the world from the point of the view of the robot is not just for debugging - it will also give you ideas on how to improve the algorithms. It will also let you explain the brains of the robot to your colleagues, boss, and customers. And so on. Seeing is believing, and an image is worth a thousand words, and multimodal temporal logging is worth a thousand images :)
-
-Of course, Rerun is useful for much more than just robots. Any time you have any for of sensors, or 2D or 3D state evolving over time, Rerun would be a great tool.
-
 ## Can't find what you're looking for?
 
 - Join us in the [Rerun Community Discord](https://discord.gg/xwcxHUjD35)