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

Remove description from example frontmatter #5832

Merged
merged 6 commits into from
Apr 7, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Apr 7, 2024

What

We were duplicating descriptions for no gain. Indeed, we were showing them double on https://www.rerun.io/examples/:

Screenshot 2024-04-07 at 18 31 25

This PR simplifies things a lot, and unifies the look.

The duplicated description is fixed in https://github.com/rerun-io/landing/commit/af157fa42788128a40d6395bf5a16dc0d4aa87b8

The result looks like this:
Screenshot 2024-04-07 at 18 37 55

An added bonus is that the description now can have hyperlinks in it.

I also updated the template README.md:s so they can be used as templates.

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!

@emilk emilk added 📖 documentation Improvements or additions to documentation examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md labels Apr 7, 2024
Copy link

github-actions bot commented Apr 7, 2024

Deployed docs

Commit Link
8e10a12 https://landing-je4r9zd7f-rerun.vercel.app/docs

@emilk emilk changed the title Emilk/remove example descriptions Remove description from example frontmatter Apr 7, 2024
@emilk emilk merged commit 660bf56 into release-0.15 Apr 7, 2024
33 checks passed
@emilk emilk deleted the emilk/remove-example-descriptions branch April 7, 2024 17:45
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 examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant