Introduce the Snippet Index #8383
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
teh-cmc
added
📖 documentation
|
Latest documentation preview deployed successfully.
Note: This comment is updated whenever you push a commit. |
teh-cmc
commented
Dec 10, 2024
|
|
||
| // --- | ||
|
|
||
| /// Returns `true` if the given name has not been released yet. |
There was a problem hiding this comment.
While I find this approach Good Enough ™️, I'm all ears if someone has something nicer.
|
Web viewer failed to build.
Note: This comment is updated whenever you push a commit. |
This was
linked to
issues
Dec 10, 2024
teh-cmc
force-pushed
the
cmc/snippets_index_1_autogen
branch
from
8431cfb to
3493bfa
Compare
zehiko
approved these changes
Dec 10, 2024
teh-cmc
force-pushed
the
cmc/snippets_index_1_autogen
branch
from
3493bfa to
8aaa8a8
Compare
teh-cmc
added a commit
that referenced
this pull request
Dec 10, 2024
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
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
All the codegen to generate the autogenerated parts of the new snippet index.
Rendered
codegen/docs/mod.rs->codegen/docs/website.rs#8382Generated data can be re-used for: