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

Split the API examples into sub-pages #2438

Merged
merged 29 commits into from
Jun 18, 2023
Merged

Split the API examples into sub-pages #2438

merged 29 commits into from
Jun 18, 2023

Conversation

jleibs
Copy link
Member

@jleibs jleibs commented Jun 15, 2023

What

Preview using the latest version of landing (python code samples first, shadows around images, no glitching on scroll, etc.)

image

More individual component cleanup will happen in subsequent PRs.

Checklist

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

Docs preview: https://rerun.io/preview/5757435/docs
Examples preview: https://rerun.io/preview/5757435/examples

@jleibs jleibs force-pushed the jleibs/api_examples branch 6 times, most recently from 56594cf to 2d3b921 Compare June 15, 2023 21:08
@jleibs jleibs force-pushed the jleibs/api_examples branch from 7d72daa to b82ef66 Compare June 16, 2023 15:31
@jleibs jleibs force-pushed the jleibs/api_examples branch from 88adb73 to 97b9d40 Compare June 16, 2023 16:16
@jleibs jleibs force-pushed the jleibs/api_examples branch from 76372c3 to a64cbb6 Compare June 16, 2023 17:10
@jleibs jleibs force-pushed the jleibs/api_examples branch 2 times, most recently from 0514372 to 3d015dc Compare June 16, 2023 17:27
@jleibs jleibs force-pushed the jleibs/api_examples branch from 3d015dc to 7d1f6c3 Compare June 16, 2023 17:28
@jleibs jleibs added the 📖 documentation Improvements or additions to documentation label Jun 16, 2023
@jleibs jleibs marked this pull request as ready for review June 16, 2023 18:12
@jleibs jleibs changed the title WIP: Refactoring the API examples Refactoring the API examples Jun 16, 2023
@jleibs jleibs changed the title Refactoring the API examples Split the API examples into sub-pages Jun 16, 2023
@jleibs jleibs force-pushed the jleibs/api_examples branch from 9820fc4 to dc3c4b1 Compare June 16, 2023 18:55
@jleibs jleibs mentioned this pull request Jun 14, 2023
26 tasks
Copy link
Member

@Wumpf Wumpf left a comment

Choose a reason for hiding this comment

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

love the opening page

---
`Point2d` represents a singular point in two-dimensional space with optional color, radii, and label. `Point2d` entities will be drawn as part of the 2D Spatial SpaceView.

It is compatible with [`AnnotationContext`](../../concepts/annotation-context.md). `class_id` can be used to provide
Copy link
Member

Choose a reason for hiding this comment

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

that's true for most things actually, not sure if we want to repeat that text on all of them? 🤔
Sadly not all ofc..


It is compatible with [`AnnotationContext`](../../concepts/annotation-context.md). `class_id` can be used to provide
colors and labels from the annotation context, and `keypoint_id` can be used to make connected edges between points. See
examples in the `AnnotationContext` documentation.
Copy link
Member

Choose a reason for hiding this comment

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

missing link

Copy link
Member

@abey79 abey79 left a comment

Choose a reason for hiding this comment

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

@jleibs I just noticed the spurious ) in viewer-walkthrough line 240. Can you remove it?

@jleibs jleibs requested a review from abey79 June 17, 2023 18:53
@jleibs jleibs merged commit 8baa377 into main Jun 18, 2023
@jleibs jleibs deleted the jleibs/api_examples branch June 18, 2023 02:47
nikolausWest added a commit that referenced this pull request Jun 19, 2023
### What

Continues following the pattern established from:
- #2438

Contributes to:
 - #2382

Preview:
-
https://landing-2yxomjvlz-rerun.vercel.app/preview/d8d222a/docs/reference/data_types

### Checklist
* [ ] 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/2467

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

---------

Co-authored-by: Nikolaus West <[email protected]>
Co-authored-by: Nikolaus West <[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.

4 participants