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

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

Open
cfeliciano7792 opened this issue May 23, 2024 · 2 comments · May be fixed by #3519
Open

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

cfeliciano7792 opened this issue May 23, 2024 · 2 comments · May be fixed by #3519
Labels
Area: Docs Affects documentation
Milestone

Comments

@cfeliciano7792
Copy link

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 cfeliciano7792 added the Area: Docs Affects documentation label May 23, 2024
@cfeliciano7792
Copy link
Author

I can work on this!

@cfeliciano7792 cfeliciano7792 linked a pull request May 29, 2024 that will close this issue
2 tasks
@cfeliciano7792
Copy link
Author

Pull request made.

@dopplershift dopplershift added this to the 1.6.3 milestone Jun 17, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: Docs Affects documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants