High-level documentation for rerun

Related tags

Utilities rerun-docs
Overview

rerun-docs

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

Other documentation

API-level documentation for Python and Rust are stored along with the source-code in the main Rerun repository

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 /docs.

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

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

/docs
    /code-examples
        /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
Comments
  • Fix link

    Fix link

    opened by emilk 10
  • CI: Add spell checking and links checking

    CI: Add spell checking and links checking

    opened by rasmusgo 5
  • Quickstart for using the viewer

    Quickstart for using the viewer

    The quickstart covers:

    • Installing the Rerun SDK
    • Launching the demo
    • The viewer panels
    • Exploring data
    • Navigating the timeline
    • Configuring views
    • Creating new views

    View the deploy preview here: https://deploy-preview-196--beep-boop-seeing-robots.netlify.app/docs/getting-started/quickstart

    Checklist

    opened by jleibs 4
  • Getting started (py)

    Getting started (py)

    • For Python users
    • For Rust users
    • Getting started with Python

    This doesn't cover Getting started with Rust on purpose, let's polish the python one first and then it'll be mostly a job of translating content from one ecosystem to another.

    Future technical improvements

    • Incremental code widget to make following the tutorial much easier
    • Better production value for screenshots & GIFs (well, until we have stable Rerun Web)
    • Grab code directly from the main repo during build rather than copy paste
    • "Copy to clipboard" on our source snippets would also be hotness (@jleibs)
    • Other stuff I don't remember right now
    opened by teh-cmc 4
  • Document viewer + timeline

    Document viewer + timeline

    First pass on viewer on reference page

    Fixes https://github.com/rerun-io/rerun/issues/972

    Don't think more detail is helpful right now but please let me know in the comments what you think is missing

    Checklist

    opened by Wumpf 4
  • Fix markdown links checker

    Fix markdown links checker

    opened by rasmusgo 1
  • docs index pages

    docs index pages

    Checklist

    Update the main index pages in the documentation. In particular make the /docs page look nicer.

    opened by nikolausWest 1
  • add getting-started/troubleshooting

    add getting-started/troubleshooting

    Add an empty getting-started/troubleshooting page.

    Will fill later, but we need to decide on the URL now so we can link to it from main readme.

    https://github.com/rerun-io/rerun/issues/1294

    opened by teh-cmc 1
  • Getting Started (rs)

    Getting Started (rs)

    What the title says.

    https://deploy-preview-200--beep-boop-seeing-robots.netlify.app/

    Note: this is gonna need a serious pass over all links once the docs are up.

    opened by teh-cmc 1
  • Document sdk operating modes

    Document sdk operating modes

    Rendered (well, not really, but close enough :upside_down_face:)

    • Copy could use a hand :grimacing:
    • Not sure if that's the right place either
    • Now that I look at this, I think this information should be way more prominent everywhere... maybe link to it on the landing doc page of each respective SDK..?
    opened by teh-cmc 0
  • Rearrange demos

    Rearrange demos

    Put minimal demo first, then pretty demos, last the demos with artificial data.

    I also added a nice screenshot of the minimal demo

    Checklist

    opened by emilk 0
Owner
rerun.io
Visualizing real world computer vision, powered by Rust
rerun.io
GitHub https://www.rerun.io/docs
A high level diffing library for rust based on diffs

Similar: A Diffing Library Similar is a dependency free crate for Rust that implements different diffing algorithms and high level interfaces for it.

Armin Ronacher 617 Dec 30, 2022
High level rust abstractions for the libretro API

libretro-rs Design Philosophy The approach to this crate can best be summarized as wanting to expose all functionality, even if not idiomatically. The

null 9 Dec 25, 2022
Rust mid-level IR Abstract Interpreter

MIRAI MIRAI is an abstract interpreter for the Rust compiler's mid-level intermediate representation (MIR). It is intended to become a widely used sta

Facebook Experimental 793 Jan 2, 2023
A low-ish level tool for easily writing and hosting WASM based plugins.

A low-ish level tool for easily writing and hosting WASM based plugins. The goal of wasm_plugin is to make communicating across the host-plugin bounda

Alec Deason 62 Sep 20, 2022
A low-level I/O ownership and borrowing library

This library introduces OwnedFd, BorrowedFd, and supporting types and traits, and corresponding features for Windows, which implement safe owning and

Dan Gohman 74 Jan 2, 2023
Mononym is a library for creating unique type-level names for each value in Rust.

Mononym is a library for creating unique type-level names for each value in Rust.

MaybeVoid 52 Dec 16, 2022
Low level access to ATmega32U4 registers in Rust

Deprecation Note: This crate will soon be deprecated in favor of avr-device. The approach of generating the svd from hand-written register definitions

Rahix 9 Jan 27, 2021
A Rust framework to develop and use plugins within your project, without worrying about the low-level details.

VPlugin: A plugin framework for Rust. Website | Issues | Documentation VPlugin is a Rust framework to develop and use plugins on applications and libr

VPlugin 11 Dec 31, 2022
Let Tauri's transparent background rendering window be stacked on Bevy's rendering window in real time to run the game with native-level performance!

Native Bevy with Tauri HUD DEMO 将 Tauri 的透明背景渲染窗口实时叠在 Bevy 的渲染窗口上，以使用原生级别性能运行游戏！ Let Tauri's transparent background rendering window be stacked on Bev

伊欧 3 Mar 25, 2024
Simple procedural macros `tnconst![...]`, `pconst![...]`, `nconst![...]` and `uconst![...]` that returns the type level integer from `typenum` crate.

typenum-consts Procedural macros that take a literal integer (or the result of an evaluation of simple mathematical expressions or an environment vari

Jim Chng 3 Mar 30, 2024
hy-rs, pronounced high rise, provides a unified and portable to the hypervisor APIs provided by various platforms.

Introduction The hy-rs crate, pronounced as high rise, provides a unified and portable interface to the hypervisor APIs provided by various platforms.

S.J.R. van Schaik 12 Nov 1, 2022
A high-performance SPSC bounded circular buffer of bytes

Cueue A high performance, single-producer, single-consumer, bounded circular buffer of contiguous elements, that supports lock-free atomic batch opera

Thaler Benedek 38 Dec 28, 2022
Monorep for fnRPC (high performance serverless rpc framework)

fnrpc Monorep for fnRPC (high performance serverless rpc framework) cli Cli tool help build and manage functions Create RPC functions Create & Manage

Faasly 3 Dec 21, 2022
High-performance BitTorrent tracker compatible with UNIT3D tracker software

UNIT3D-Announce High-performance backend BitTorrent tracker compatible with UNIT3D tracker software. Usage # Clone this repository $ git clone https:/

HDInnovations 4 Feb 6, 2023
A code generator to reduce repetitive tasks and build high-quality Rust libraries. 🦀

LibMake A code generator to reduce repetitive tasks and build high-quality Rust libraries Welcome to libmake ?? Website • Documentation • Report Bug •

Sebastien Rousseau 27 Mar 12, 2023
High-performance QEMU memory and instruction tracing

Cannoli Cannoli is a high-performance tracing engine for qemu-user. It can record a trace of both PCs executed, as well as memory operations. It consi

Margin Research 412 Oct 18, 2023
A high-performance Lambda authorizer for API Gateway that can validate OIDC tokens

oidc-authorizer A high-performance token-based API Gateway authorizer Lambda that can validate OIDC-issued JWT tokens. ?? Use case This project provid

Luciano Mammino 4 Oct 30, 2023
High-performance, Reliable ChatGLM SDK natural language processing in Rust-Lang

RustGLM for ChatGLM Rust SDK - 中文文档 High-performance, high-quality Experience and Reliable ChatGLM SDK natural language processing in Rust-Language 1.

Blueokanna 3 Feb 29, 2024
Easy c̵̰͠r̵̛̠ö̴̪s̶̩̒s̵̭̀-t̶̲͝h̶̯̚r̵̺͐e̷̖̽ḁ̴̍d̶̖̔ ȓ̵͙ė̶͎ḟ̴͙e̸̖͛r̶̖͗ë̶̱́ṉ̵̒ĉ̷̥e̷͚̍ s̷̹͌h̷̲̉a̵̭͋r̷̫̊ḭ̵̊n̷̬͂g̵̦̃ f̶̻̊ơ̵̜ṟ̸̈́ R̵̞̋ù̵̺s̷̖̅ţ̸͗!̸̼͋

Rust S̵̓i̸̓n̵̉ I̴n̴f̶e̸r̵n̷a̴l mutability! Howdy, friendly Rust developer! Ever had a value get m̵̯̅ð̶͊v̴̮̾ê̴̼͘d away right under your nose just when

null 294 Dec 23, 2022
The open source design documentation tool for everybody

Heads up: reimagining artifact 3.0, check it out at artifact_py Artifact: design documentation for everybody Note: this project, and the python re-wri

Rett Berg 564 Nov 15, 2022