Skip to content

Conversation

@najuna-brian
Copy link
Contributor

@najuna-brian najuna-brian commented Jul 27, 2025

Description

Fixes oversized images across Build section by implementing Hextra cards shortcode as recommended in #1866.

License

The software is provided under AGPL-3.0. Contributions to this project are
accepted under the same license.

@najuna-brian
Copy link
Contributor Author

Refinement: Reverted unrelated formatting changes to focus purely on image optimization per #1866.

Copy link
Contributor

@mrjones-plip mrjones-plip left a comment

Choose a reason for hiding this comment

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

@najuna-brian - thanks so much for taking initiative to improve our docs! It's always great to see a new PR come in 💯

I've commented on the first few items I found, but I'd like you to look at the rest of the images based on my initial input to ensure they've actually improved.

Do you use AI to generate your text? I ask because it has come up once before where you posted a long body of text and were requested to simplify it. Using AI is not an issue, but causing extra work for others is.

While not as bad this time, your PR body text is too long. AI generated text may take you seconds to generate, but it takes humans minutes, or longer, to read and make sure all text and it's meaning is accounted for.

Like the code in a PR, the body text should be just long enough communicate the changes to a review, but no longer. For example, you don't need to list the problem, that's what the ticket is for. Reviewers know how to test a docs PR. The files changes section in the body is a duplicate of the native Files changed section. If I were submitting this PR, I would use this text below. You're welcome to use it verbatim or see if you want to use your own word!

please update the PR body to be much, much shorter 🙏


This PR:

  • uses Hextra cards to better size images shortcode per #1866.
  • updates contacts, branding, targets, contact and image pages

Comment on lines -29 to +31
{{< figure src="branding_elements.png" link="branding_elements.png" class="center col-6 col-lg-8" >}}
{{< cards cols="1" >}}
{{< card image="branding_elements.png" method="Resize" options="600x q80 webp" >}}
{{< /cards >}}
Copy link
Contributor

Choose a reason for hiding this comment

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

Your branch seems to have made the image both bigger and added a background. I think the original image, being smaller and having no background is better. Can you please revert or try again?

Your branch is on the left, production is on the right:

image

Copy link
Contributor Author

@najuna-brian najuna-brian Jul 28, 2025

Choose a reason for hiding this comment

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

yeah i used ai to generate the PR
I will now keep the brief and on point as guided

Let me look at the changes i made again as well
Thank you @mrjones-plip

Copy link
Contributor

Choose a reason for hiding this comment

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

Great - thanks for being receptive to my feedback

@andrablaj
Copy link
Member

Hi @najuna-brian! Did you have some time to review @mrjones-plip's feedback? Please don't hesitate to reach out if you have any questions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants