search

Unidata / MetPy

MetPy is a collection of tools in Python for reading, visualizing and performing calculations with weather data.
https://unidata.github.io/MetPy/
BSD 3-Clause "New" or "Revised" License
1.21k stars 408 forks source link

Enhance the README in the Tutorials Section with Beginner-Friendly Details #3514

Open cfeliciano7792 opened 1 month ago

cfeliciano7792 commented 1 month ago

What can be better?

Hi everyone!

The current README for the tutorial section lacks detailed information that will help users understand and utilize the tutorials effectively. To improve the user experience and make it easier for users to get started, I propose updating the tutorials README documentation with the following additions:

Purpose of the Tutorials:

A brief explanation of the tutorials' objectives and what users can expect to learn from them.

Descriptions of Current Tutorials:

A brief description of each tutorial currently available, providing users with an overview of what each tutorial covers.

Categorization by Difficulty:

Organizing the tutorials into sections based on their difficulty level (e.g., beginner, intermediate, advanced) to help users choose the appropriate tutorial for their skill level.

I think these changes will help provide clear guidance and structure, making it easier for users to navigate and benefit from the MetPy tutorials!

cfeliciano7792 commented 1 month ago

I can work on this!

cfeliciano7792 commented 1 month ago

Pull request made.