Skip to content

Commit

Permalink
Update docs with guides and tutorials for blueprint (#5641)
Browse files Browse the repository at this point in the history
### What

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using newly built examples:
[app.rerun.io](https://app.rerun.io/pr/5641/index.html)
* Using examples from latest `main` build:
[app.rerun.io](https://app.rerun.io/pr/5641/index.html?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[app.rerun.io](https://app.rerun.io/pr/5641/index.html?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/5641)
- [Docs
preview](https://rerun.io/preview/6f446839fca3b9fb1ac26407cb7ed65d1da1aa7c/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/6f446839fca3b9fb1ac26407cb7ed65d1da1aa7c/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
  • Loading branch information
jleibs authored Apr 2, 2024
1 parent a671f02 commit af7283e
Show file tree
Hide file tree
Showing 12 changed files with 916 additions and 10 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/documentation.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -38,10 +38,11 @@ jobs:
# * skip changelog PR links (so many)
# * skip speculative links
# * Stackoverflow links are no longer accessible from CI.
# * Tuxfamily.org links are down intermittently.
# * Nyud links are down every now and then.
# * TODO(#4085): https://rerun-io.github.io/rerun/dev/bench/ often 404:s for unknown reasons
# * TODO(#4556): remove the `static.rerun.io` and `github.com` skips
linksToSkip: "https://stackoverflow.com/.*, https://cs.nyu.edu/~silberman/datasets/nyu_depth_v2.html, https://static.rerun.io/.*, https://github.com/.*, https://crates.io/crates/.*, https://github.com/rerun-io/rerun/pull/.*, .*?speculative-link, https://rerun-io.github.io/rerun/dev/bench/"
linksToSkip: "https://stackoverflow.com/.*, https://eigen.tuxfamily.org/, https://cs.nyu.edu/~silberman/datasets/nyu_depth_v2.html, https://static.rerun.io/.*, https://github.com/.*, https://crates.io/crates/.*, https://github.com/rerun-io/rerun/pull/.*, .*?speculative-link, https://rerun-io.github.io/rerun/dev/bench/"
retry: true
retryErrors: true
retryErrorsCount: 5
Expand Down
6 changes: 0 additions & 6 deletions docs/content/getting-started/visualize/blueprint.md

This file was deleted.

25 changes: 25 additions & 0 deletions docs/content/howto/configure-the-viewer.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
title: Configure the Viewer
order: 10
---

Although the Rerun Viewer tries to do a reasonable job of using heuristics to automatically determine
an appropriate layout given the data that you provide, there will always be situations where the heuristic
results don't match the needs of a particular use-case.

Fortunately, almost all aspects of the viewer can be configured via the [Blueprint](../reference/viewer/blueprint.md).

The viewer Blueprint completely determines:

- What contents are included in each view
- The type of view used to visualize the data
- The organizational layout and names of the different view panels and containers
- Configuration and styling properties of the individual data visualizers

There are a few different ways to work with Blueprints:

- [Blueprints can be modified interactively](./configure-the-viewer/interactively.md)
- [Blueprint files (.rbl) can be saved and loaded from disk](./configure-the-viewer/save-and-load.md)
- [Blueprints can be controlled directly from code](./configure-the-viewer/through-code.md)

For a hands on example, you can also follow the [Blueprint API Tutorial](./configure-the-viewer/blueprint-api-tutorial.md).
Loading

0 comments on commit af7283e

Please sign in to comment.