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.

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

Flesh out archetype docs and simple code examples fo rmore types #2467

Merged
merged 14 commits into from
Jun 19, 2023

Conversation

jleibs
Copy link
Member

@jleibs jleibs commented Jun 19, 2023

What

Continues following the pattern established from:

Contributes to:

Preview:

Checklist

PR Build Summary: https://build.rerun.io/pr/2467

Docs preview: https://rerun.io/preview/5eba986/docs
Examples preview: https://rerun.io/preview/5eba986/examples

@jleibs jleibs added the 📖 documentation Improvements or additions to documentation label Jun 19, 2023
@jleibs jleibs force-pushed the jleibs/archetype_docs branch from 1c90ba4 to a717603 Compare June 19, 2023 05:07
@jleibs jleibs marked this pull request as ready for review June 19, 2023 05:11
Additionally, arrows can be drawn with color, radius, and labels. The radius controls the thickness of the arrow.

Notes:
* In the python APIs `radius` is currently derived from `width_scale`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'll go ahead and merge without fixing this but we should really say what this relationship is @jleibs

Copy link
Member

@nikolausWest nikolausWest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good after comments and a couple updated screenshots (collapsing blueprint where possible)

Comment on lines 26 to 32
<picture>
<source media="(max-width: 480px)" srcset="https://static.rerun.io/3f8a63c38f2e3b5dc0389a87a7760fb5931af06c_arrow3d_simple_480w.png">
<source media="(max-width: 768px)" srcset="https://static.rerun.io/09d2af7cb9e274c120025851baee99cd72f01831_arrow3d_simple_768w.png">
<source media="(max-width: 1024px)" srcset="https://static.rerun.io/5e7e3b1f9117bdc546ed516ed82b4579a13b9c8a_arrow3d_simple_1024w.png">
<source media="(max-width: 1200px)" srcset="https://static.rerun.io/8524cc65f1d84a26b2808400aa1d64224b1fd4da_arrow3d_simple_1200w.png">
<img style="width: 75%" src="https://static.rerun.io/1505438a73ca779a6e2c3c3b3b41f67ce62c724b_arrow3d_simple_full.png" alt="">
</picture>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's keep the blueprint collapsed if we can so we don't need to update these when we update the blueprint view

docs/content/reference/data_types/box3d.md Outdated Show resolved Hide resolved

Notes:
* There is not currently a python API for logging a batch of linestrips.
* In the python APIs `radius` is currently derived from `stroke_width`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jleibs I'll merge this now but we should explain how it's derived in the future

docs/cspell.json Outdated Show resolved Hide resolved
@nikolausWest nikolausWest merged commit 4b18c4b into main Jun 19, 2023
@nikolausWest nikolausWest deleted the jleibs/archetype_docs branch June 19, 2023 10:43
jleibs added a commit that referenced this pull request Jun 20, 2023
…n image (#2474)

### What

Fill out more archetype docs:
- image
- tensor
- depth image
- segmentation image

Follow up to:
- #2467 

In parallel to:
- #2473 

### 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)
* [ ] ~~I've included a screenshot or gif (if applicable)~~

<!-- This line will get updated when the PR build summary job finishes.
-->
PR Build Summary: https://build.rerun.io/pr/2474

<!-- pr-link-docs:start -->
Docs preview: https://rerun.io/preview/7925ce9/docs
Examples preview: https://rerun.io/preview/7925ce9/examples
<!-- pr-link-docs:end -->

---------

Co-authored-by: Nikolaus West <[email protected]>
Co-authored-by: Nikolaus West <[email protected]>
Co-authored-by: Jeremy Leibs <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants