-
Notifications
You must be signed in to change notification settings - Fork 13
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
Improve readability of documentation #632
Conversation
New to xCDAT? Check out the getting started guides. | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just removed the text (I thought these were self-explanatory enough), but I don't object to short text descriptions.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm okay with no text
:gutter: 2 | ||
|
||
.. grid-item-card:: Project Overview | ||
:img-top: ../_static/icons/dashboard.png |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I downloaded png and then noticed you used svg. I can change this (the file sizes are small either way).
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for adding these links. .png
is fine
path: examples/general-utilities.ipynb | ||
thumbnail: _static/dataset-diagram.webp | ||
|
||
- title: Calculate Geospatial Weighted Averages from Monthly Time Series | ||
- title: Spatial Averaging |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I will update the notebook title, too, so that this is reflected in the table of contents link.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds good
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This PR looks good to me. I don't have anything else to add.
Shortening the titles for the Gallery thumbnails was a great idea. The thumbnail squares fit nicely together since they are all the same size now.
I'm going to merge this PR to get it in for v0.7.0 |
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #632 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 15 15
Lines 1543 1543
=========================================
Hits 1543 1543 ☔ View full report in Codecov by Sentry. |
Description
Shortens (removes) text in tiles on landing pages, adds grid links to Getting Started page, shortens titles for gallery grid links.
Checklist
If applicable: