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

Unify example READMEs to improve onboarding experience #5434

Open
nikolausWest opened this issue Mar 8, 2024 · 1 comment
Open

Unify example READMEs to improve onboarding experience #5434

nikolausWest opened this issue Mar 8, 2024 · 1 comment
Assignees
Labels
📖 documentation Improvements or additions to documentation enhancement New feature or request

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Mar 8, 2024

Update all example READMEs to follow the template set forth here: #5359 (comment) excluding the "Logging and Visualizing with Rerun" section.

As a part of achieving:

We should do a pass over all example README's that end up as example detail pages on the website. This issue is about doing everything except the section with code snippets (that make it a mini-tutorial). The goal is to orient users around "what it is they are looking at" (an example of visualizing X with Rerun by logging data), and how to run the code. For external examples how to run the code can just refer to the external repository.

The goal is to make the examples more useful for people who are new to Rerun and are exploring what you can do with it.

See this (Rerun private) page for more context.

@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation enhancement New feature or request labels Mar 8, 2024
@nikolausWest nikolausWest added this to the 0.15 milestone Mar 8, 2024
@nikolausWest nikolausWest changed the title Unify example READMEs Unify example READMEs to improve onboarding experience Mar 25, 2024
@jleibs jleibs modified the milestones: 0.15, 0.15.1 Apr 9, 2024
@emilk emilk modified the milestones: 0.15.1, Spring Cleaning Apr 24, 2024
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 enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

4 participants