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

Make sure archetype docs are thorough and correct #3504

Closed
nikolausWest opened this issue Sep 27, 2023 · 3 comments · Fixed by #3648
Closed

Make sure archetype docs are thorough and correct #3504

nikolausWest opened this issue Sep 27, 2023 · 3 comments · Fixed by #3648
Assignees
Labels
📖 documentation Improvements or additions to documentation 🍏 primitives Relating to Rerun primitives

Comments

@nikolausWest
Copy link
Member

After landing

Take another pass over all archetype pages and make sure:

  • Text is correct and descriptive
  • We use the correct "pluralness" (Arrow3D vs Arrows3D) everywhere (title, and in text)
  • We link to the correct Python docs (Arrows3D instead of log_arrow)
  • Includes at least one code example
  • Each code example has a screenshot
@nikolausWest nikolausWest added 📖 documentation Improvements or additions to documentation 🍏 primitives Relating to Rerun primitives labels Sep 27, 2023
@nikolausWest nikolausWest changed the title Make sure archetype docs are correct Make sure archetype docs are thorough and correct Sep 27, 2023
@jprochazk jprochazk mentioned this issue Sep 28, 2023
9 tasks
@Wumpf
Copy link
Member

Wumpf commented Sep 29, 2023

@emilk
Copy link
Member

emilk commented Oct 3, 2023

We should make sure each archetype has a single good example. More than one example is sometimes warranted, but more often a single good one is preferred.

@emilk
Copy link
Member

emilk commented Oct 3, 2023

tensor_one_dim of Tensor archetype is wrong; should be moved to barchart

@Wumpf Wumpf self-assigned this Oct 3, 2023
Wumpf added a commit that referenced this issue Oct 4, 2023
### What

* Fixes #3504
* Introduce `!api` attribute to make some examples show up only in the
api doc
* Reduce api doc example count to 1 on all archetypes
* some example tweaks
* formulation tweaks
* additional cross references to api docs
* tons of images and example title updates

The only archetypes that don't follow strictly the rule of "all examples
have an image and everything exactly one example in the api doc" are:
* Text Document is not embedded in any api doc since black chokes on the
embedded markdown
* clear recursive doesn't have an image because it's just too boring


### 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 [demo.rerun.io](https://demo.rerun.io/pr/3648) (if
applicable)~

- [PR Build Summary](https://build.rerun.io/pr/3648)
- [Docs
preview](https://rerun.io/preview/31d5ca547f737a8296375bff33f4f4426fd9061a/docs)
<!--DOCS-PREVIEW-->
- [Examples
preview](https://rerun.io/preview/31d5ca547f737a8296375bff33f4f4426fd9061a/examples)
<!--EXAMPLES-PREVIEW-->
- [Recent benchmark results](https://ref.rerun.io/dev/bench/)
- [Wasm size tracking](https://ref.rerun.io/dev/sizes/)
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 🍏 primitives Relating to Rerun primitives
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants