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

Docs: improve discoverability of image compression #5675

Merged
merged 9 commits into from
Mar 26, 2024

Conversation

emilk
Copy link
Member

@emilk emilk commented Mar 25, 2024

What

We often talk to customers that are unaware that we support logging encoded/compressed images.
So I added some docs for this (in 3096c17).

This became a 🐰🕳️ because the doc tags (\py etc) didn't work as expected: they would put all language-specific stuff at the end, but in this case I wanted it interleaved into the rest of the docs. So I fixed that, with a lot of effort.
Now \cpp, \py, \rs acts like a simple per-line filter.

In the meantime I removed some unused code, making everything shorter in the process.

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 codegen/idl include in changelog labels Mar 25, 2024
Copy link

github-actions bot commented Mar 25, 2024

Size changes

Name main 5675/merge Change
rrt-star.rrd 8.16 MiB 5.78 MiB -29.17%

@emilk emilk force-pushed the emilk/improve-image-docs branch from 70a2660 to 5e9c473 Compare March 25, 2024 17:08
@emilk emilk force-pushed the emilk/improve-image-docs branch from aa8d353 to ddb42eb Compare March 25, 2024 17:59
@emilk emilk marked this pull request as ready for review March 25, 2024 18:08
@teh-cmc teh-cmc self-requested a review March 26, 2024 07:48
@emilk emilk merged commit e5ebdf6 into main Mar 26, 2024
38 of 39 checks passed
@emilk emilk deleted the emilk/improve-image-docs branch March 26, 2024 09:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codegen/idl 📖 documentation Improvements or additions to documentation include in changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants