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

Generate archetype docs #2775

Closed
teh-cmc opened this issue Jul 21, 2023 · 1 comment · Fixed by #3445
Closed

Generate archetype docs #2775

teh-cmc opened this issue Jul 21, 2023 · 1 comment · Fixed by #3445
Assignees
Labels
codegen/idl 📖 documentation Improvements or additions to documentation

Comments

@teh-cmc
Copy link
Member

teh-cmc commented Jul 21, 2023

We require 3 different kinds of docs for our archetypes:

  • Native language docs (docstrings)
    This is automatically handled by codegen already.
  • Doc reference
    We need to completely overhaul this for the new type-based APIs, and as much as possible automate it via codegen or it's going to be out-of-sync very fast.
  • High-level example page (doesn't exist yet!)
    Needs to show a thumbnail for all archetypes and link to the reference.

API references are already taken care of by the language-specific codegen backends, but we still need a codegen backend that takes IDL definitions in and turn them into documentation for the website (e.g. all the archetype related pages).

Contents of:
docs/content/reference/data_types

@teh-cmc teh-cmc added 📖 documentation Improvements or additions to documentation codegen/idl labels Jul 21, 2023
@teh-cmc teh-cmc changed the title Implement web-doc codegen backend Archetype docs Aug 25, 2023
@emilk
Copy link
Member

emilk commented Sep 11, 2023

Related: the doc-examples should be auto-included. No need to add manual \cpp ## Example to all our archetypes imho.

That way we will also catch any missing doc-examples

@emilk emilk changed the title Archetype docs Generate archetype docs Sep 18, 2023
@jprochazk jprochazk mentioned this issue Sep 27, 2023
9 tasks
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]>
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

Successfully merging a pull request may close this issue.

4 participants