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

Stop using <h1> in example README.md #5817

Merged
merged 1 commit into from
Apr 5, 2024
Merged

Conversation

abey79
Copy link
Contributor

@abey79 abey79 commented Apr 5, 2024

What

<h1> is for the page title, that is autogenerated by the front end. The README should only contains <h2> and lower. This PR fixes all the readme and adds a lint for that (available with python scripts/lint.py --extra).

Would benefit from https://github.com/rerun-io/landing/issues/521 being solved.

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!

@abey79 abey79 added examples Issues relating to the Rerun examples exclude from changelog PRs with this won't show up in CHANGELOG.md labels Apr 5, 2024
@abey79 abey79 merged commit 3f4d2f9 into release-0.15 Apr 5, 2024
35 checks passed
@abey79 abey79 deleted the antoine/no-h1-in-readme branch April 5, 2024 19:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

None yet

2 participants