Add code examples & screenshots for all blueprint view types #6304
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Wumpf
added
📖 documentation
Deployed docs
|
|
2D and 3D view screenshots look indistuingishable. No good! |
Wumpf
force-pushed
the
andreas/more-view-docs
branch
from
95d9e02 to
2b69128
Compare
|
Fixed. They are now distinctively 3D/2D:
|
5 tasks
jleibs
approved these changes
May 14, 2024
crates/re_types/definitions/rerun/blueprint/views/text_document.fbs
Outdated
Show resolved
Hide resolved
Wumpf
added a commit
that referenced
this pull request
May 14, 2024
### 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What
Checklist
mainbuild: rerun.io/viewernightlybuild: rerun.io/viewerTo run all checks from
main, comment on the PR with@rerun-bot full-check.