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

Improve Component documentation #3042

Closed
abey79 opened this issue Aug 18, 2023 · 2 comments
Closed

Improve Component documentation #3042

abey79 opened this issue Aug 18, 2023 · 2 comments
Labels
codegen/idl 📖 documentation Improvements or additions to documentation

Comments

@abey79
Copy link
Member

abey79 commented Aug 18, 2023

The "Loggable Data Types" section lists all archetypes' components but we don't have a documentation of their semantics (and underlying data type).

This should be improved as follows:

  • each component should have a dedicated, linkable paragraph providing data-centric information (what they contain, what's their semantic)
  • links in archetypes' docs
@abey79 abey79 added 📖 documentation Improvements or additions to documentation codegen/idl labels Aug 18, 2023
@abey79 abey79 added this to the 0.9 milestone Aug 18, 2023
@emilk emilk added 🏎️ Quick Issue Can be fixed in a few hours or less and removed 🏎️ Quick Issue Can be fixed in a few hours or less labels Sep 11, 2023
@emilk
Copy link
Member

emilk commented Sep 24, 2023

I think this can be fixed with the same docs-generation as @jprochazk is working on for #2775

@emilk
Copy link
Member

emilk commented Oct 9, 2023

There is good documentation for all components now at https://www.rerun.io/docs/reference/types/components

@emilk emilk closed this as completed Oct 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codegen/idl 📖 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants