Skip to content

Added annotated illustrations of the figure GUI #25925

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
wants to merge 3 commits into from

Conversation

satisf1ed
Copy link

PR summary

Closes #25266
Added annotated illustrations of the figure GUI to explain what different buttons do

PR checklist

@tacaswell
Copy link
Member

Thank you for this work, however I am skeptical of adding several MB of gifs both to the main repo and to the built docs.

@satisf1ed
Copy link
Author

Yes, I thought about GIFs. I can try to replace them with images (e. g. for button "forward" I can attach image below)

Screenshot 2023-05-19 at 19 27 12

@story645
Copy link
Member

I like the idea of this a lot...@satisf1ed could you provide the code and render the gifs as part of the build process? I'm thinking maybe as separate or one big animation? I'm not sure it'd be smaller but either way I'd prefer that for maintainability.

@tacaswell
Copy link
Member

Thank you for your work on this @satisf1ed , but I am going to decline this PR.

Restoring the old docs I think addresses the main issue. In addition to the method of using our actual icon assets ensuring that the images in the docs do not get out of sync, by just showing the buttons we can side-step the issue that different GUI toolkits have the toolbar in different places (but they all use the same icons).

It may be worth copy-editing the descriptions of what the buttons do, but that will be sufficiently different that I think it would be best to start a new branch + PR for that work.

Please do not be discouraged and I hope we hear from you again!

@tacaswell tacaswell closed this Jan 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Waiting for author
Development

Successfully merging this pull request may close these issues.

4 participants