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

Turn all in-repo C++ examples into mini-tutorials #5436

Open
nikolausWest opened this issue Mar 8, 2024 · 2 comments
Open

Turn all in-repo C++ examples into mini-tutorials #5436

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

Comments

@nikolausWest
Copy link
Member

After #5434, add the "Logging and Visualizing with Rerun" section to all example READMEs, in effect turning them into mini-tutorials on how to use Rerun.

@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
@andreasnaoum
Copy link
Contributor

I noticed that C++ examples on the website redirect users to external repositories, and I have a question for the Run the Code section.

These repos also have information on how to run the example.

Should I redirect them to the example repo instead of explaining how to run it there? (see in the final section Run the Code)

image

@nikolausWest
Copy link
Member Author

Should I redirect them to the example repo instead of explaining how to run it there? (see in the final section Run the Code)

Yes, for all the external ones you can skip the code section and potentially even the "used rerun types" if thats too much work. You can just refer to the repositories for instructions on how to run

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