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

Add interactive diagram to the docs #1100

Merged
merged 4 commits into from May 25, 2022
Merged

Add interactive diagram to the docs #1100

merged 4 commits into from May 25, 2022

Conversation

joerick
Copy link
Contributor

@joerick joerick commented Apr 30, 2022

Fix #468.

This adds a diagram to the docs that summarises what steps cibuildwheel takes when building a wheel. It's interactive, so mousing over a part will show more info.

One thing I'm not sure about is where to put it in the docs. Currently it's on the 'home' page, it could have its own page. If it had its own page, I could increase the page width a bit too, which might let me increase the font size a bit.

@joerick
Copy link
Contributor Author

joerick commented Apr 30, 2022

@henryiii
Copy link
Contributor

henryiii commented May 1, 2022

Would it make sense to have the png image as a no script fallback, since you already have it? (Or does everything fall apart without JS? Do people still browse without JS sometimes?)

@henryiii
Copy link
Contributor

henryiii commented May 1, 2022

This looks fantastic, by the way!

@henryiii
Copy link
Contributor

henryiii commented May 2, 2022

Was going ask about mobile! Noticed it didn’t handle mobile very well when showing it off at PyCon.

@henryiii
Copy link
Contributor

henryiii commented May 2, 2022

The place you press seems small for going to the link on the second press?

@mayeut
Copy link
Member

mayeut commented May 8, 2022

this looks very nice !

@joerick
Copy link
Contributor Author

joerick commented May 9, 2022

The place you press seems small for going to the link on the second press?

Yes, good point. I think I'll change the tap behaviour to be: 1st tap = open tooltip. 2nd tap = follow link to docs. Tap diagram = open tooltip. tap tooltip = open docs.

@joerick
Copy link
Contributor Author

joerick commented May 9, 2022

Would it make sense to have the png image as a no script fallback, since you already have it? (Or does everything fall apart without JS? Do people still browse without JS sometimes?)

Indeed our docs do use JS for a few things already. But they still basically work so the noscript fallback is a good idea 👍

@joerick
Copy link
Contributor Author

joerick commented May 9, 2022

I'm still not sure about the location in the docs, but this will do for the moment I think.

@joerick joerick marked this pull request as ready for review May 9, 2022 14:21
Copy link
Contributor

@henryiii henryiii left a comment

Choose a reason for hiding this comment

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

Thought I already did this.

@henryiii
Copy link
Contributor

Should we merge before release so it gets in the stable docs?

@joerick joerick merged commit a08a952 into main May 25, 2022
@joerick joerick deleted the docs-diagram branch May 25, 2022 08:04
@abitrolly
Copy link
Contributor

Wow. That appeared to be very helpful. How it was made?

@abitrolly
Copy link
Contributor

@joerick I wanna reuse that. What are the conditions? :D

@joerick
Copy link
Contributor Author

joerick commented Dec 13, 2023

Same as the rest of the project, BSD license! https://github.com/pypa/cibuildwheel/blob/main/LICENSE

Go for it :)

@abitrolly
Copy link
Contributor

@joerick thanks! :D Gonna send some patches first. #1697

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.

Ideas for improving the first-run experience
4 participants