Skip to content

[bug] pixelated image on /docs #15407

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

Closed
chrifro opened this issue Nov 6, 2024 · 3 comments · Fixed by #15439
Closed

[bug] pixelated image on /docs #15407

chrifro opened this issue Nov 6, 2024 · 3 comments · Fixed by #15439
Assignees
Labels
docs Area: coder.com/docs

Comments

@chrifro
Copy link

chrifro commented Nov 6, 2024

This image is huge and pixelated. If we decrease the image size the image quality should work fine and it will be easier to grasp the information for the reader.
URL: https://coder.com/docs/CONTRIBUTING
Image

@coder-labeler coder-labeler bot added bug risk Prone to bugs docs Area: coder.com/docs labels Nov 6, 2024
@matifali
Copy link
Member

matifali commented Nov 7, 2024

Thank you for raising this. We have a general image sizing problem in our docs. And you should be able to find more examples of oversized images easily.

@EdwardAngert may have plans to fix these systematically.

@EdwardAngert
Copy link
Contributor

thanks @matifali ! I don't know if Vercel wasn't refreshing correctly or if it was something about the way I did it, but I tested with <img src... and the nextjs <Image tag, and <Image> was more successful

check it out in https://coder.com/docs/@template-from-scratch-update/tutorials/template-from-scratch#7-create-the-template-in-coder

<Image height="412px" src="../images/templates/coder-login-web.png" alt="Log in to your Coder deployment" align="center" />

I'll put a PR in for this one - I think there are probably bunches more we can probably lint for... eventually

@EdwardAngert
Copy link
Contributor

EdwardAngert commented Nov 8, 2024

@matifali I'm testing that PR with a max-width attribute, if that succeeds, I feel like we can find somewhere in src/components/Docs /HTMLRenderer.tsx Lines 107-110 to make it a rule, but I'm not totally sure how just yet. I can poke around later, but figured I'd drop it here in case it's something you already know about 🤞

source: https://nextjs.org/docs/pages/api-reference/components/image#sizes

edit edit: I might just need to take a new screenshot and set this aside. seems like the attrib I referred to gets overridden by the CSS when rendered? there's a potential answer I found on stack overflow, but I haven't tried to work that into our CSS

EdwardAngert added a commit that referenced this issue Nov 8, 2024
resolves #15407

adjust manual github action screenshot in contributing.md


[preview](https://coder.com/docs/@15407-contrib-image/CONTRIBUTING#deploying-a-pr)
(once ready)

---------

Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Area: coder.com/docs
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants