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 C++ to in-viewer quick-start guide #3870

Closed
Tracked by #2919
abey79 opened this issue Oct 16, 2023 · 0 comments · Fixed by #3961
Closed
Tracked by #2919

Add C++ to in-viewer quick-start guide #3870

abey79 opened this issue Oct 16, 2023 · 0 comments · Fixed by #3961
Assignees
Labels
🌊 C++ API C/C++ API specific ui concerns graphical user interface
Milestone

Comments

@abey79
Copy link
Member

abey79 commented Oct 16, 2023

Add quick start content for C++

@abey79 abey79 added ui concerns graphical user interface 🌊 C++ API C/C++ API specific labels Oct 16, 2023
@abey79 abey79 added this to the 0.10 C++ milestone Oct 16, 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]>
@abey79 abey79 mentioned this issue Oct 17, 2023
33 tasks
@emilk emilk self-assigned this Oct 23, 2023
@emilk emilk changed the title Quick start: add a quick start guide for C++ Add C++ to in-viewer quick-start guide Oct 23, 2023
emilk added a commit that referenced this issue Oct 24, 2023
### What
* Closes #3870

### 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/3961) (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/3961)
- [Docs
preview](https://rerun.io/preview/fa4ad5362c6e9f66b97eedf9fc60a68586f2ae9d/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/fa4ad5362c6e9f66b97eedf9fc60a68586f2ae9d/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)

---------

Co-authored-by: Andreas Reich <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🌊 C++ API C/C++ API specific ui concerns graphical user interface
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants