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

Automatically generate list of used archetype in each example #5662

Closed
emilk opened this issue Mar 25, 2024 · 0 comments · Fixed by #8383
Closed

Automatically generate list of used archetype in each example #5662

emilk opened this issue Mar 25, 2024 · 0 comments · Fixed by #8383
Assignees
@teh-cmc
Labels
🧑‍💻 dev experience developer experience (excluding CI) examples Issues relating to the Rerun examples
Milestone
Spring Cleaning

Comments

@emilk
Copy link
Member

emilk commented Mar 25, 2024

We've started manually listing the archetypes used in an example in the README.md fronttmatter, but this is error prone and difficult to maintain. We should automate this instead.
@emilk emilk added enhancement New feature or request 👀 needs triage This issue needs to be triaged by the Rerun team 🧑‍💻 dev experience developer experience (excluding CI) examples Issues relating to the Rerun examples and removed enhancement New feature or request 👀 needs triage This issue needs to be triaged by the Rerun team labels Mar 25, 2024
@emilk emilk added this to the Spring Cleaning milestone Apr 24, 2024
@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: 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
🧑‍💻 dev experience developer experience (excluding CI) examples Issues relating to the Rerun examples
Projects
None yet
Milestone
Spring Cleaning
Development

Successfully merging a pull request may close this issue.

Introduce the Snippet Index rerun-io/rerun
2 participants
@emilk @teh-cmc