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

Improve Welcome Screen's Getting Started section #3095

Closed
abey79 opened this issue Aug 24, 2023 · 1 comment · Fixed by #3813
Closed

Improve Welcome Screen's Getting Started section #3095

abey79 opened this issue Aug 24, 2023 · 1 comment · Fixed by #3813
Assignees
Labels
ui concerns graphical user interface
Milestone

Comments

@abey79
Copy link
Member

abey79 commented Aug 24, 2023

Currently, we only have links to the docs' getting started section for Python and Rust.

We need:

  1. integrate the "getting started" (as markdown) inside the viewer
  2. add support for C++ as well
@abey79 abey79 added the ui concerns graphical user interface label Aug 24, 2023
@nikolausWest
Copy link
Member

Image

Ideal flow for the getting started section:

  • Press the "Python/Rust/C++ Quickstart" button
  • This runs code in the viewer that starts a new recording and logs a markdown document to the recording
  • The code includes three sections:
    1. "Install the Rerun SDK" with minimal instructions on how to install the Rerun SDK (pip install rerun-sdk)
    2. "Stream data to this viewer" with copy short past-able code (for instance twisting cube) that streams data to the current viewer and recording. The init code should be dynamically set up so that it will connect and stream to the current viewer and recording. The code should include sleeps so that the user can see the data stream in (i.e. not all show up in one chunk)
    3. "How it works" with a basic rundown of how it works (although the code should be well documented)

It's important that this works both in the browser and the native viewer.

@abey79 abey79 self-assigned this Oct 9, 2023
abey79 added a commit that referenced this issue Oct 17, 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):
- markdown formatting issue where H1 appears smaller than H2 (current
work around: skip on using H1)
  - #3612
- specialise Quick Start for non-server Viewers
  - #3871 
- write Quick Start for C++:
  - #3870 
- markdown formatting issue:
  - lampsitter/egui_commonmark#19

<img width="1315" alt="image"
src="https://github.com/rerun-io/rerun/assets/49431240/232b4a79-7917-4978-95d1-94474142da94">

* Fixes #3095


### 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 [demo.rerun.io](https://demo.rerun.io/pr/3813) (if
applicable)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG

- [PR Build Summary](https://build.rerun.io/pr/3813)
- [Docs
preview](https://rerun.io/preview/9c7ebbf37a890b5d09941102a4d7c3a35f53f277/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/9c7ebbf37a890b5d09941102a4d7c3a35f53f277/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)

---------

Co-authored-by: Emil Ernerfeldt <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ui concerns graphical user interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants