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.

Sign up for GitHub

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

Jump to bottom

Use archetypes and api's used in examples as tags to filter on #2934

Open
Tracked by #2932
nikolausWest opened this issue Aug 7, 2023 · 0 comments
Open
Tracked by #2932

Use archetypes and api's used in examples as tags to filter on #2934

nikolausWest opened this issue Aug 7, 2023 · 0 comments
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples 🍏 primitives Relating to Rerun primitives

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Aug 7, 2023 •
edited
Loading

It's very useful to be able to find for instance all examples that log the archetype Points3D. It's similarly nice to be able to glance over an example's page and see what api's and archetypes / components were used in the example.

We should

  • Parse the example code and extract all the Rerun archetypes and (explicitly logged) components.
  • Add these as a new category of tags that you can use to filter examples on rerun.io/examples
  • Potentially: also use this knowledge to add "used in" links to the documentation of each of the archetypes
@nikolausWest nikolausWest mentioned this issue Aug 7, 2023
Open
5 tasks
@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples 🍏 primitives Relating to Rerun primitives labels Aug 7, 2023
@teh-cmc teh-cmc mentioned this issue Dec 10, 2024
Merged
teh-cmc added a commit that referenced this issue Dec 10, 2024
@teh-cmc
Snippet index: implement codegen foundations (#8383)
6b40cd5 
All the codegen to generate the autogenerated parts of the new snippet
index.


[Rendered](https://github.com/rerun-io/rerun/blob/cmc/snippets_index_1_autogen/docs/snippets/INDEX.md)

* Fixes #1123
* Fixes #5662
* DNM: requires #8382

Generated data can be re-used for:
* #2934
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples 🍏 primitives Relating to Rerun primitives
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@nikolausWest