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 an "API Usage Examples" page #2382

Closed
26 tasks done
Tracked by #2385
nikolausWest opened this issue Jun 12, 2023 · 1 comment
Closed
26 tasks done
Tracked by #2385

Add an "API Usage Examples" page #2382

nikolausWest opened this issue Jun 12, 2023 · 1 comment
Assignees
@jleibs
Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples

Comments

@nikolausWest
Copy link
Member

nikolausWest commented Jun 12, 2023 •
edited
Loading

As seen in #1599, users need a simple way to get an overview of everything that can be logged since our other examples have too much algorithm code and other distractions.

Building on top of:

  • Split the API examples into sub-pages #2438

  • Need to finish updating the templates for the types:

    • Arrow3D
    • Rect2D
    • Box3D
    • Linestrip2d
    • Linestrip3d
    • Mesh
    • Point2D
    • Point3D
    • Transform3D
    • Pinhole
    • Image
    • DepthImage
    • SegmentationImage
    • Tensor
    • Scalar
    • TextEntry
    • AnnotationContext

  • Convert the "Primitives" page in docs to an "API Usage Examples"

    • Use the work "Archetype" instead of "Primitives"
    • Document what an archetype is under "Data Model" together with components, entities, etc
    • Link to this page from the Examples page
    • Add small code snippets (Rust, Python code-switcher) for each archetype together with a screenshot of how it looks. Code snippets should be copy-pastable
      • Only use synthetic data for all examples
      • Python
      • Rust
    • Make sure we include simple examples for things like drawing skeletons with annotation contexts
@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples labels Jun 12, 2023
@abey79 abey79 mentioned this issue Jun 12, 2023
Closed
10 tasks
@emilk emilk mentioned this issue Jun 12, 2023
Closed
@nikolausWest
Copy link
Member Author

Note for meshes: explicitly include normals and comment that if you don't include them, the meshes will be rendered flat.

@jleibs jleibs mentioned this issue Jun 19, 2023
Merged
2 tasks
nikolausWest added a commit that referenced this issue Jun 19, 2023
@jleibs @nikolausWest
Flesh out archetype docs and simple code examples for more types (#2467)
4b18c4b 
### 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
Assignees

@jleibs jleibs

Labels
📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@nikolausWest @jleibs