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

Documentation for archetype and views references each other #6319

Merged
merged 15 commits into from
May 14, 2024

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented May 14, 2024

What


  • 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.!

image image

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested the web demo (if applicable):
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG
  • If applicable, add a new check to the release checklist!

To run all checks from main, comment on the PR with @rerun-bot full-check.

@Wumpf Wumpf added 📖 documentation Improvements or additions to documentation include in changelog labels May 14, 2024
Copy link

github-actions bot commented May 14, 2024

Deployed docs

Commit Link
b159508 https://landing-53c8rnpbp-rerun.vercel.app/docs

Base automatically changed from andreas/more-view-docs to main May 14, 2024 16:07
@Wumpf Wumpf force-pushed the andreas/improve-view-reference-docs branch from 5f283c1 to ff93693 Compare May 14, 2024 16:09
Copy link
Member

@jleibs jleibs left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

crates/re_types/definitions/rerun/archetypes/mesh3d.fbs Outdated Show resolved Hide resolved
@Wumpf Wumpf force-pushed the andreas/improve-view-reference-docs branch from 867dfd1 to b159508 Compare May 14, 2024 16:57
@Wumpf Wumpf merged commit 74998a4 into main May 14, 2024
35 checks passed
@Wumpf Wumpf deleted the andreas/improve-view-reference-docs branch May 14, 2024 19:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Reference documentation for Space View blueprint classes & their properties
2 participants