Generate documentation for components/data types #3503
Assignees
Labels
codegen/idl
🧑💻 dev experience
developer experience (excluding CI)
📖 documentation
Improvements or additions to documentation
Comments
jprochazk
added
📖 documentation
jprochazk
added a commit
that referenced
this issue
Sep 28, 2023
### What Closes #2775 - [x] Add docs as a new "language" in codegen - [x] Replace old docs with new ones - [x] Minor output polish work - [x] Components and APIs section should say "Required Components" instead of just "Required" (for all kinds) - [x] Use actual headings for example titles - [x] Use images even in `.rs`/`.py` files Follow-up work: #3503 ### 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/3445) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/3445) - [Docs preview](https://rerun.io/preview/3bd57dabdaea4a24bd6c67301e321734fadee864/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/3bd57dabdaea4a24bd6c67301e321734fadee864/examples) <!--EXAMPLES-PREVIEW--> - [Recent benchmark results](https://ref.rerun.io/dev/bench/) - [Wasm size tracking](https://ref.rerun.io/dev/sizes/) --------- Co-authored-by: Emil Ernerfeldt <[email protected]>
jprochazk
added a commit
that referenced
this issue
Oct 2, 2023
### What * Closes #3503 ### 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/3535) (if applicable) - [PR Build Summary](https://build.rerun.io/pr/3535) - [Docs preview](https://rerun.io/preview/9a5f7290e23ae2c14ec3d80de5d2df6015056787/docs) <!--DOCS-PREVIEW--> - [Examples preview](https://rerun.io/preview/9a5f7290e23ae2c14ec3d80de5d2df6015056787/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
We currently only generate docs for archetypes into
docs/content/reference/data_types(done in #3445). We should also generate docs for:We should have a single language-specific top-level page for all available components/data types/archetypes.
We should also have links (and backlinks!) between archetypes->components, so that users can easily navigate the documentation.
The text was updated successfully, but these errors were encountered: