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

updated the installation page with tab based navigation #608

Conversation

Musharraffaijaz
Copy link
Contributor

@Musharraffaijaz Musharraffaijaz commented Jan 30, 2025

Kindly check the changes, all the installation steps are changed into tab-based navigation
The PR resolves the Issue: DOC: update installation page #811

image

Copy link

netlify bot commented Jan 30, 2025

Deploy Preview for scipy-org ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 6a096bf
🔍 Latest deploy log https://app.netlify.com/sites/scipy-org/deploys/67a36afe2636db0008ebc836
😎 Deploy Preview https://deploy-preview-608--scipy-org.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
Lighthouse
Lighthouse
1 paths audited
Performance: 100
Accessibility: 100
Best Practices: 100
SEO: 100
PWA: -
View the detailed breakdown and full score reports

To edit notification comments on pull requests, go to your Netlify site configuration.

@Musharraffaijaz
Copy link
Contributor Author

The PR resolves the Issue: DOC: update installation page #811

Copy link
Member

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

I think the widget in its current state leaves too little space for text on smaller screens, which is a problem on mobile:

image

@jarrodmillman
Copy link
Member

jarrodmillman commented Jan 30, 2025

@Musharraffaijaz Please use the theme's built-in shortcode for tabs: https://theme.scientific-python.org/shortcodes/#tabs

If there are issues with the styling of the built-in tabs, it should be addressed here https://github.com/pydata/pydata-sphinx-theme/

@Musharraffaijaz
Copy link
Contributor Author

Alright, will do the changes.

…stallation navigation to the themes built-in shortcode for tabs
@Musharraffaijaz
Copy link
Contributor Author

Musharraffaijaz commented Jan 30, 2025

The latest commits are done using the theme's in build shortcode for tabs. Kindly check the Screen Shot below
image

@Musharraffaijaz
Copy link
Contributor Author

@jarrodmillman is it possible if we could change the styling of the tabs a bit maybe? Instead of having a border at the top can we just change it to bottom border only and a highlighting on hover?

Copy link
Member

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

I really like how this looks now! One thing - please could you keep the type stubs section separate (i.e. not as a tab)? It's basically something extra to look at after already understanding one of the tabs, rather than instead of the tabs.

@lucascolley lucascolley dismissed their stale review January 30, 2025 19:21

addressed

@Musharraffaijaz
Copy link
Contributor Author

Great to know you liked it, sure will keep the type stubs separate.

@jarrodmillman
Copy link
Member

@jarrodmillman is it possible if we could change the styling of the tabs a bit maybe? Instead of having a border at the top can we just change it to bottom border only and a highlighting on hover?

We are using the pydata-sphinx-theme styling for the scientific-python-hugo-theme. So you will need to get the changes to the tab styling implemented here: https://github.com/pydata/pydata-sphinx-theme/

Copy link
Contributor

@mattip mattip left a comment

Choose a reason for hiding this comment

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

I really like this layout, in my opinion it is better UX

content/en/install.md Outdated Show resolved Hide resolved
Copy link
Member

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

the hyperlinks on lines 17 to 20 don't work any more - I think they can just be removed now

@Musharraffaijaz
Copy link
Contributor Author

Musharraffaijaz commented Jan 31, 2025

The latest changes includes:
Moved the Type stubes from the tab based navigation
Removed the hyper links from line 17 - 20
Moved the "Try Scipy" out of the tab based navigation
image

@Musharraffaijaz
Copy link
Contributor Author

@lucascolley is there anything else which needs to be done here?

content/en/install.md Outdated Show resolved Hide resolved
content/en/install.md Outdated Show resolved Hide resolved
content/en/install.md Outdated Show resolved Hide resolved
@lucascolley lucascolley self-requested a review February 4, 2025 08:58
Copy link
Member

@lucascolley lucascolley left a comment

Choose a reason for hiding this comment

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

thanks @Musharraffaijaz, this looks good to me and is a nice improvement!

@Musharraffaijaz
Copy link
Contributor Author

thanks @Musharraffaijaz, this looks good to me and is a nice improvement!

Thanks @lucascolley, I'm glad it was helpful. I'm always looking to learn and improve, so I'd be keen to discuss any other areas in the projects where I could contribute.

@lucascolley
Copy link
Member

alright, merging - thanks again @Musharraffaijaz !

@lucascolley lucascolley merged commit 8dbf5ba into scipy:main Feb 5, 2025
4 checks passed
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.

4 participants