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

Add organizational folders to snippets #6131

Closed
jleibs opened this issue Apr 26, 2024 · 0 comments · Fixed by #6219
Closed

Add organizational folders to snippets #6131

jleibs opened this issue Apr 26, 2024 · 0 comments · Fixed by #6219
Labels
📖 documentation Improvements or additions to documentation

Comments

@jleibs
Copy link
Member

jleibs commented Apr 26, 2024

All snippets currently go in a folder called "all" for a historical reason I don't full understand. #6120 starts to introduce view snippets, which is only going to make the already-overhwhelming structure moreso.

We should introduce a structure to organize these into:

  • archetypes/
  • views/
  • tutorials/

etc.
This was referenced Apr 27, 2024
Closed
Merged
jleibs added a commit that referenced this issue May 9, 2024
@Wumpf @jleibs
Folder structure for code snippets (#6219)
0f34aaa 
### What

* Fixes #6131
* Fixes #6132
* Fixes #6133

(either someone fell victim to a github glitch, or really liked creating
issues about this 😄)

The compare snippet script needed quite a bit of love to make this work.

### Checklist
* [x] I have read and agree to [Contributor
Guide](https://github.com/rerun-io/rerun/blob/main/CONTRIBUTING.md) and
the [Code of
Conduct](https://github.com/rerun-io/rerun/blob/main/CODE_OF_CONDUCT.md)
* [x] I've included a screenshot or gif (if applicable)
* [x] I have tested the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6219?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6219?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6219)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.

---------

Co-authored-by: Jeremy Leibs <jeremy@rerun.io>
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
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Folder structure for code snippets rerun-io/rerun
1 participant
@jleibs