Move example description to README frontmatter #3201
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abey79
added
🧑💻 dev experience
|
cc @martenbjork |
jprochazk
approved these changes
Sep 4, 2023
abey79
added a commit
that referenced
this pull request
Sep 4, 2023
6 tasks
abey79
added a commit
that referenced
this pull request
Sep 6, 2023
### What Add Example page to the Welcome Screen. Fixes #3096 <img width="1366" alt="image" src="https://github.com/rerun-io/rerun/assets/49431240/bbe2e84e-9ade-4da8-b095-d7b0f396c26f"> ### TODO - [x] fix layout issues - [x] display tags - [x] have dedicated, short copy for the description: #3201 ### Not included in this PR - **WARNING**: here, we bake in a manifest with hard-coded links to RRDs that were generated within this PR. This will lead to issue down the line, when the RRD format changes. - #3212 - #3213 - download updated manifest - #3190 - load thumbnail from the web - emilk/egui#3291 - provide feedback while downloading a RRD - #3192 ### 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/3191) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/3191) - [Docs preview](https://rerun.io/preview/3be107e4cc6aa6758a3f22c27a79233b33f2ea6b/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/3be107e4cc6aa6758a3f22c27a79233b33f2ea6b/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 <emil.ernerfeldt@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
The description for the few examples included in
demo.rerun.ioand in the in-app example page was so far stored inscripts/ci/build_demo_app.py. This PR moves this information to these examples' respective README.md frontmatter. Thebuild_demo_app.pyis updated accordingly.This description should be used for the in-app and web example pages, as well as for the help button in
demo.rerun.io. For layout purposes, it is important that this description remains short. This PR introduces a lint to enforce a 130 character limit.Note:
demo.rerun.iobecome much smaller now, since the new description format has to be compact. This is acceptable as this will be sunsetted in favour ofapp.rerun.io+ in-app example page (seeapp.rerun.ioshould default to a blank viewer with the Welcome Screen #3196)Checklist
I've included a screenshot or gif (if applicable)