Skip to content

Update docs to describe Rerun post query APIs #7499

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
12 tasks done
nikolausWest opened this issue Sep 24, 2024 · 0 comments · Fixed by #7852
Closed
12 tasks done

Update docs to describe Rerun post query APIs #7499

nikolausWest opened this issue Sep 24, 2024 · 0 comments · Fixed by #7852
Labels
📖 documentation Improvements or additions to documentation

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Sep 24, 2024 •
edited by teh-cmc
Loading

The new query APIs affect "what Rerun is" quite substantially. Rerun goes from being an SDK for visualizing multimodal data over time to a set of tools to visualize and handle multimodal data over time. This requireetting starteds changes in multiple places throughout the docs.

The following pages need to be updated to reflect this new view of what Rerun is:

  • Getting started
  • How-to
    • New section: "Read back data from rrd files"
      • New page: "Export time-series from rrd files to Pandas"
      • Add links to the the Getting started guide to more detailed material (see todos in the guide)
  • Reference: DataFrame Query API
  • Docs snippets
    • DataframeView: add a screenshot & inline viewer for the example code
  • Update python SDK generated docs to include the dataframe API.
@nikolausWest nikolausWest added the 📖 documentation Improvements or additions to documentation label Sep 24, 2024
@nikolausWest nikolausWest mentioned this issue Oct 14, 2024
Merged
6 tasks
@teh-cmc teh-cmc mentioned this issue Oct 21, 2024
Merged
6 tasks
emilk pushed a commit that referenced this issue Oct 22, 2024
@teh-cmc
reference/viewer/viewport: add dataframe view to the list (#7852)
fe6e3b6 
* Closes #7499

### 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 examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7852?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/7852?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)!
* [x] If have noted any breaking changes to the log API in
`CHANGELOG.md` and the migration guide

- [PR Build Summary](https://build.rerun.io/pr/7852)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
@Wumpf Wumpf removed this from the Next patch release milestone Feb 6, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

reference/viewer/viewport: add dataframe view to the list rerun-io/rerun
3 participants
@emilk @Wumpf @nikolausWest