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

Update Edge Introduction pictures #53

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Conversation

matkuliak
Copy link
Contributor

@matkuliak matkuliak commented Feb 13, 2024

Summary of the changes / Why this is an improvement

  • updated Edge Intro pictures
  • removed :scale: 50%

Checklist

@matkuliak matkuliak added the documentation Improvements or additions to documentation label Feb 13, 2024
@matkuliak matkuliak requested a review from amotl February 13, 2024 14:19
@matkuliak matkuliak changed the title Updated Edge Introduction pictures Update Edge Introduction pictures Feb 13, 2024
@matkuliak matkuliak requested a review from msbt February 13, 2024 14:20
@amotl
Copy link
Member

amotl commented Feb 13, 2024

Hi. Was it just some conversion using oxipng, or are those real updates? If the latter is the case, I would like to suggest to switch to a better style/paradigm of having screenshots in the documentation.

https://thisisimportant.net/posts/screenshots-in-documentation/
-- via: https://news.ycombinator.com/item?id=38639629

My proposal is to use the ideas from Simplified Screenshots exclusively, and apply them gradually when reworking the documentation, and when adding new content. wdyt?

While they might take a bit longer to make, simplified screenshots don’t need to be updated as frequently because you can obscure parts of the UI that are irrelevant for your task, unavailable to users with specific roles or permissions, or that might otherwise be confusing.

Sorry about that "more work" bit. My suggestion does not want to hide that it is more workload on the content authors. However, as you know we are aiming for documentation excellency, we humbly ask content authors to pay that tribute.

Copy link
Member

@amotl amotl left a comment

Choose a reason for hiding this comment

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

Acknowledging. Please still consider our suggestion about Simplified Screenshots. It might be a dedicated round of updates, and we do not want to block you from merging.

@matkuliak
Copy link
Contributor Author

matkuliak commented Feb 13, 2024

Hi. I see where you're coming from.
Screenshots are highly debatable topic, I agree that we could do them better. For one, we could (should?) do fewer of them. I am guilty of this myself, it's easy to rely on them.

I added "screenshot overhaul" to my backlog and will consider your suggestion, thank you. Obscuring parts sound like a good idea to me.

@matkuliak matkuliak merged commit 126bbad into main Feb 13, 2024
3 checks passed
@matkuliak matkuliak deleted the mm/edge-introduction-update branch February 13, 2024 18:56
@amotl
Copy link
Member

amotl commented Feb 13, 2024

Thanks!

Obscuring parts sound like a good idea to me.

Not only obscuring, but also cropping down to the element of interest. 👍

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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants