search

alan-turing-institute / deepsensor

A Python package for tackling diverse environmental prediction tasks with NPs.
https://alan-turing-institute.github.io/deepsensor/
MIT License
69 stars 12 forks source link

💡 Suggestions for revisions of documentation #87

Open kallewesterling opened 8 months ago

kallewesterling commented 8 months ago

We're thrilled to now have new, extensive documentation for the DeepSensor package! This is a significant milestone in making our tool more accessible and user-friendly for everyone.

What's New?

Our new documentation is designed to provide a comprehensive guide that includes:

We Need Your Input!

While we've put in a considerable amount of effort to ensure the documentation is as detailed and helpful as possible, we know there's always room for improvement. That's where you come in!

We are actively seeking feedback from our community to make our documentation even better.

Here's how you can help:

  1. Read Through the Documentation Take a stroll through our new docs and see how they feel. Are they easy to understand? Is there something missing that you would have liked to see?
  2. Leave Your Comments We're opening this thread to collect all your comments and feedback. Don't hold back! Every piece of feedback is valuable, whether it's praise, criticism, or suggestions.
  3. Share Your Experience Did you find a particular section of the documentation especially helpful or confusing? Let us know your experience navigating through the information.

Contribution Guidelines (Coming Soon!)

We are also in the process of implementing guidelines for how to contribute to the documentation. Stay tuned for updates on this front! (We'll drop a comment below when we have updates.)

How to Comment

To leave a comment, simply reply to this GitHub issue. If you have suggestions for specific sections or pages, please include the link or a reference to that section/page in your comment.

Thank You!

Your feedback is instrumental in helping us serve our community better. We appreciate your time and effort in helping us enhance the DeepSensor Python package documentation. Looking forward to hearing your thoughts!

tom-andersson commented 4 months ago

There are some hard-coded hyperlinks to the old documentation URL (tom-andersson.github.io/deepsensor) which we need to fix, for example in the API reference link here, which now go to a 404.