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

Shorten and unify in-example description markdowns #5440

Closed
5 tasks
nikolausWest opened this issue Mar 8, 2024 · 1 comment
Closed
5 tasks

Shorten and unify in-example description markdowns #5440

nikolausWest opened this issue Mar 8, 2024 · 1 comment
Assignees
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Milestone

Comments

@nikolausWest
Copy link
Member

The in-app markdown description can be a great way to share some context about what you're looking at for someone that opened an example without a deep understanding of what that is. It isn't a good place for a tutorial / deeper description since the in-app markdown documents provide a much worse reading experience than our website.

Example:
Screenshot 2024-03-08 at 11 28 30

We should unify these in app markdown descriptions to:

  • Be much shorter and just give enough information to orient someone who opened an example on app.reru.io without much context.
    • They need to know that this is an example recording of X, built using Rerun.
    • It should link to some key pieces of data in the recording
    • Link to documentation and the source code
  • Each example we include on app.rerun.io should have a markdown description
@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples labels Mar 8, 2024
@nikolausWest nikolausWest added this to the Triage milestone Mar 8, 2024
@emilk emilk changed the title Unify in-example description markdowns Shorten and unify in-example description markdowns Mar 25, 2024
@emilk emilk assigned emilk and unassigned emilk Apr 8, 2024
@emilk
Copy link
Member

emilk commented Apr 8, 2024

My work-list:

  • arkit_scenes
  • detect_and_track_objects
  • dicom_mri
  • dna
  • human_pose_tracking
  • nuscenes
  • open_photogrammetry_format
  • plots
  • raw_mesh
  • rgbd
  • rrt-star
  • segment_anything_model
  • structure_from_motion

emilk added a commit that referenced this issue Apr 8, 2024
### What
* Closes #5440

All `main` and `nightly` examples now include an inline markdown
description. I made sure it is not too long. I've adjusted the
blueprints where suitable.

### 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 newly built examples:
[rerun.io/viewer](https://rerun.io/viewer/pr/5855)
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/5855?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/5855?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)!

- [PR Build Summary](https://build.rerun.io/pr/5855)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Projects
None yet
Development

No branches or pull requests

2 participants