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

Examples: feature matrix table to know what's where #1123

Closed
Tracked by #1119
teh-cmc opened this issue Feb 7, 2023 · 3 comments · Fixed by #8383
Closed
Tracked by #1119

Examples: feature matrix table to know what's where #1123

teh-cmc opened this issue Feb 7, 2023 · 3 comments · Fixed by #8383
Assignees
@teh-cmc
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples

Comments

@teh-cmc
Copy link
Member

teh-cmc commented Feb 7, 2023

Akin to e.g. wgpu's feature matrix
@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples labels Feb 7, 2023
@teh-cmc teh-cmc mentioned this issue Feb 7, 2023
Closed
7 tasks
@Wumpf
Copy link
Member

Wumpf commented Feb 15, 2023

we have an example doc page by now but a feature matrix would still be nice

@emilk
Copy link
Member

emilk commented Jun 12, 2023

Related:

@abey79
Copy link
Member

abey79 commented Jun 21, 2023

I think the proper way to achieve this would be to have either a dedicated front matter property in the examples, or some custom feat:point3d-style tags. What do you think @jprochazk?

@teh-cmc teh-cmc self-assigned this Dec 10, 2024
@teh-cmc teh-cmc mentioned this issue Dec 10, 2024
Merged
@teh-cmc teh-cmc linked a pull request Dec 10, 2024 that will close this issue
Introduce the Snippet Index #8383
Merged
This was referenced Dec 10, 2024
Merged
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
teh-cmc added a commit that referenced this issue Dec 10, 2024
@teh-cmc
Snippet index: support for manual opt-outs (#8385)
7d0036e 
Adds the ability to manually opt-out of the index for specific
snippets/archetypes/components.

E.g.:
```toml
# These snippets will be excluded from the snippet index, unconditionally.
[snippets_ref.snippets.opt_out]
"archetypes/manual_indicator" = []

# These archetypes will ignore the associated snippets in the snippet index.
[snippets_ref.archetypes.opt_out]
"DataframeQuery" = [
  "reference/dataframe_save_blueprint"
]

# These components will ignore the associated snippets in the snippet index.
[snippets_ref.components.opt_out]
"ShowLabels" = [
  "tutorials/data_out",
]
```

Config will have to be filled over time!


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

* Part of #1123
* Part of #5662
* DNM: requires #8383
teh-cmc added a commit that referenced this issue Dec 10, 2024
@teh-cmc
Snippet index: support for enumerating custom features (#8386)
1a1c5de 
Adds the ability to manually enumerate custom things.

E.g.:
```toml
# These arbitrary feature names will be indexed exactly as written down.
# Add anything you can think about!
[snippets_ref.features]
"Dataframes" = [
  "reference/dataframe_query",
  "reference/dataframe_view_query",
]
"`AnyValue`" = [
  "tutorials/any_values",
  "tutorials/extra_values",
  "howto/any_values_send_columns",
]
```

Config will have to be filled over time!


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

* Part of #1123
* Part of #5662
* DNM: requires #8385
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@teh-cmc teh-cmc

Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Introduce the Snippet Index rerun-io/rerun
4 participants
@emilk @Wumpf @teh-cmc @abey79