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

Redesign the front page of the docs #238

Merged
merged 9 commits into from
Jun 8, 2021
Merged

Redesign the front page of the docs #238

merged 9 commits into from
Jun 8, 2021

Conversation

leouieda
Copy link
Member

@leouieda leouieda commented Jun 7, 2021

Remove the wall of text and make clear boxes for getting started, asking for help, API reference, and citing. Include the full table of contents underneath to help with navigation. Move the text about different use cases to a "Why Pooch?" page. Introduces the sphinx-panels extension to use cards, columns, and tabs.

Preview of the built docs: https://www.leouieda.com/docs-previews/pooch/238/

Reminders:

  • Run make format and make check to make sure the code follows the style guide.
  • Add tests for new features or tests that would have caught the bug that you're fixing.
  • Add new public functions/methods/classes to doc/api/index.rst and the base __init__.py file for the package.
  • Write detailed docstrings for all functions/classes/methods. It often helps to design better code if you write the docstrings first.
  • If adding new functionality, add an example to the docstring, gallery, and/or tutorials.
  • Add your full name, affiliation, and ORCID (optional) to the AUTHORS.md file (if you haven't already) in case you'd like to be listed as an author on the Zenodo archive of the next release.

@leouieda leouieda requested a review from aguspesce June 7, 2021 21:57
@leouieda
Copy link
Member Author

leouieda commented Jun 7, 2021

@prisae @aguspesce @santisoler what do you think?

Copy link
Member

@prisae prisae left a comment

Choose a reason for hiding this comment

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

I like it, I think it makes it easier to get started. Also the new tabs on the About and Installing sections look neat!

@santisoler
Copy link
Member

This looks awesome! I ❤️ the tabs! And the cards in the front page looks amazing.

The only thing I would change is the color of the text inside the buttons when hovering. Currently, when hovering over the buttons, the text inside them is shown in the same original blue color, while the button itself fills with another tone of blue, drastically lowering the contrast of the text and its background. Besides the aesthetics, I think we should change that to improve accessibility.

@leouieda
Copy link
Member Author

leouieda commented Jun 8, 2021

Thanks @santisoler @prisae! That was an easy fix. Merging this in!

@leouieda leouieda merged commit 1da4a30 into master Jun 8, 2021
@leouieda leouieda deleted the frontpage branch June 8, 2021 15:58
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