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

Improve readability of documentation #632

Merged
merged 2 commits into from
Apr 10, 2024

Conversation

pochedls
Copy link
Collaborator

@pochedls pochedls commented Mar 29, 2024

Description

Shortens (removes) text in tiles on landing pages, adds grid links to Getting Started page, shortens titles for gallery grid links.

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • My changes generate no new warnings
  • Any dependent changes have been merged and published in downstream modules

If applicable:

  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass with my changes (locally and CI/CD build)
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have noted that this is a breaking change for a major release (fix or feature that would cause existing functionality to not work as expected)

@pochedls pochedls requested a review from tomvothecoder March 29, 2024 02:42
Comment on lines -24 to -25
New to xCDAT? Check out the getting started guides.

Copy link
Collaborator Author

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.

Copy link
Collaborator

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
Copy link
Collaborator Author

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).

Copy link
Collaborator

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
Copy link
Collaborator Author

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.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Sounds good

Copy link
Collaborator

@tomvothecoder tomvothecoder left a 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.

@tomvothecoder tomvothecoder changed the title Initial work on #630 Improve readability of documentation Apr 10, 2024
@tomvothecoder
Copy link
Collaborator

I'm going to merge this PR to get it in for v0.7.0

@tomvothecoder tomvothecoder added the type: docs Updates to documentation label Apr 10, 2024
Copy link

codecov bot commented Apr 10, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (1f4d22a) to head (03e271e).

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.
📢 Have feedback on the report? Share it here.

@tomvothecoder tomvothecoder merged commit 65c0be6 into xCDAT:main Apr 10, 2024
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs Updates to documentation
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[Doc]: Updates to improve readability
2 participants