Skip to content
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.

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

Add basic support for in-app "Quick Start" guides #3813

Merged
merged 22 commits into from
Oct 17, 2023

Conversation

abey79
Copy link
Member

@abey79 abey79 commented Oct 11, 2023

What

This PR lays the basis for in-app "Quick Start" guides.

After a failed attempt to use re_sdk from re_viewer (can't target wasm), this PR builds on recent StoreDb API improvements to create "quick start" recordings from scratch.

This involves:

  • adding a nice StoreDb::from_info_and_rows() helper function
  • adding SystemCommand::LoadStoreDb(StoreDb)
  • adding StoreSource::Viewer (for recordings generated from the viewer itself)
  • some helper functions in welcome_page.rs

This PR also introduces a draft for the (native-only) Python and Rust Quick Starts, and placeholder for the other languages.

To address (in follow-up PR):

image

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@abey79 abey79 added ui concerns graphical user interface include in changelog labels Oct 11, 2023
@emilk emilk marked this pull request as draft October 11, 2023 16:21
@emilk
Copy link
Member

emilk commented Oct 11, 2023

I changed it to a draft because of the wasm-issue discussed in https://rerunio.slack.com/archives/C041NHU952S/p1697037259411659

@abey79 abey79 marked this pull request as ready for review October 12, 2023 15:05
crates/re_data_store/src/store_db.rs Outdated Show resolved Hide resolved
crates/re_data_store/src/store_db.rs Outdated Show resolved Hide resolved
crates/re_log_types/src/lib.rs Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/cpp_native.md Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/python_native.md Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/python_native.md Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/rust_native.md Outdated Show resolved Hide resolved
crates/re_viewer/src/ui/welcome_screen/welcome_page.rs Outdated Show resolved Hide resolved
crates/re_viewer/src/ui/welcome_screen/welcome_page.rs Outdated Show resolved Hide resolved
abey79 and others added 2 commits October 16, 2023 09:30
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
Co-authored-by: Emil Ernerfeldt <emil.ernerfeldt@gmail.com>
@abey79 abey79 added the do-not-merge Do not merge this PR label Oct 16, 2023
@abey79 abey79 removed the do-not-merge Do not merge this PR label Oct 16, 2023
Copy link
Member

@emilk emilk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, but let's pull out the actual example code to a separate file so that we make sure it will always run properly!

crates/re_viewer/data/quick_start_guides/python_native.md Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/rust_native.md Outdated Show resolved Hide resolved
crates/re_viewer/data/quick_start_guides/rust_native.md Outdated Show resolved Hide resolved
@abey79 abey79 merged commit 3c912be into main Oct 17, 2023
30 checks passed
@abey79 abey79 deleted the antoine/python-quick-start branch October 17, 2023 07:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
include in changelog ui concerns graphical user interface
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Improve Welcome Screen's Getting Started section
2 participants