This is the high-level documentation for rerun that is hosted at https://www.rerun.io/docs

Other documentation

API-level documentation is built from source-code. Python lives at rerun_py and Rust in the individual crates.

Contributions

Contributions are welcome via pull-request. Note that even landed PRs will not deploy to the main site until the next time we roll out a site-update. We will generally to do this at least once per release.

Organization

The site documentation lives in Markdown files inside /content.

The entry point to the documentation is /content/index.md

Code examples can be rendered in multiple languages by placing them in code-examples/all, like so:

/docs
  /code-examples
    /all
      /my-example
        /example.py
        /example.rs

Special syntax

Title and Navigation Order

The display titles navigation order of documentation sections are managed by the Metadata at the top of the Markdown file:

---
title: Examples
order: 6
---

Code Examples

Code-examples can be referenced in Markdown using this syntax:

code-example: my-example