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

Reference documentation for Space View blueprint classes & their properties #6082

Closed
Wumpf opened this issue Apr 23, 2024 · 0 comments · Fixed by #6319
Closed

Reference documentation for Space View blueprint classes & their properties #6082

Wumpf opened this issue Apr 23, 2024 · 0 comments · Fixed by #6319
Assignees
@Wumpf
Labels
🟦 blueprint The data that defines our UI codegen/idl 📖 documentation Improvements or additions to documentation
Milestone
0.16

Comments

@Wumpf
Copy link
Member

Wumpf commented Apr 23, 2024

Our reference should contain a list of Space View classes and their property types.

This needs to include a short codesnippet for each property which serves as a does-this-still-compile-as-expected test and should fit in similar as our other code snippets (doing comparison tests etc. as well!)

Related to (dependent even?):
@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation 🟦 blueprint The data that defines our UI codegen/idl labels Apr 23, 2024
@Wumpf Wumpf mentioned this issue Apr 23, 2024
Merged
5 tasks
@emilk emilk added this to the 0.16 milestone May 3, 2024
@jleibs jleibs removed their assignment May 6, 2024
@Wumpf Wumpf self-assigned this May 13, 2024
This was referenced May 13, 2024
Merged
Merged
Wumpf added a commit that referenced this issue May 14, 2024
@Wumpf
Add code examples & screenshots for all blueprint view types (#6304)
ac3f541 
### What

* Large portion of #6082
* Not done yet I believe - I vaguely remember still wanting to do some
more polish on how we present these pages

### 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 the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6304?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6304?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6304)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
Wumpf added a commit that referenced this issue May 14, 2024
@Wumpf
Documentation for archetype and views references each other (#6319)
74998a4 
### What

* Fixes: #6082
* Based on: #6304 
---

* Archetype link now to view that they show up in
* Views now link to archetypes that they support
* View page now lists properties with argument name and argument
documentation instead of type docs
* I also tried linking to the type's reference page but it got too much!
* changed name of 'link' section


Note to reviewer: Mind `Large diffs are not rendered by default.`!

<img width="1379" alt="image"
src="https://github.com/rerun-io/rerun/assets/1220815/c32a6329-7f9f-4a2e-8982-108a0d8e028c">
<img width="741" alt="image"
src="https://github.com/rerun-io/rerun/assets/1220815/ebe14bb7-e0bd-486a-b501-4b10c7dd0d0f">


### 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 the web demo (if applicable):
* Using examples from latest `main` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6319?manifest_url=https://app.rerun.io/version/main/examples_manifest.json)
* Using full set of examples from `nightly` build:
[rerun.io/viewer](https://rerun.io/viewer/pr/6319?manifest_url=https://app.rerun.io/version/nightly/examples_manifest.json)
* [x] The PR title and labels are set such as to maximize their
usefulness for the next release's CHANGELOG
* [x] If applicable, add a new check to the [release
checklist](https://github.com/rerun-io/rerun/blob/main/tests/python/release_checklist)!

- [PR Build Summary](https://build.rerun.io/pr/6319)
- [Recent benchmark results](https://build.rerun.io/graphs/crates.html)
- [Wasm size tracking](https://build.rerun.io/graphs/sizes.html)

To run all checks from `main`, comment on the PR with `@rerun-bot
full-check`.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Wumpf Wumpf

Labels
🟦 blueprint The data that defines our UI codegen/idl 📖 documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.16
Development

Successfully merging a pull request may close this issue.

Documentation for archetype and views references each other rerun-io/rerun
3 participants
@emilk @Wumpf @jleibs