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

Better intro for new users in docs #265

Open
johnomotani opened this issue Dec 12, 2022 · 0 comments
Open

Better intro for new users in docs #265

johnomotani opened this issue Dec 12, 2022 · 0 comments
Labels
documentation Involves writing or updating documentation help wanted Extra attention is needed

Comments

@johnomotani
Copy link
Collaborator

Some thoughts from @mikekryjak that we should follow up on:

I think the examples are great, but they assume that the user already has some experience in xarray.
I would have the following recommendations for the documentation:

  • Start with even just one simple paragraph that explains what xarray is and what its benefits are (e.g. super intuitive metadata and indexing)
  • Have a small section to explain basics of indexing, or include a link to the relevant xarray doc page (which is actually very well written)
  • Have a bullet point list of all the plotting tools that xBOUT adds with a single sentence description
  • Have a bullet point list of all the native xarray plotting tools with a single sentence description

If anyone has other suggestions, please add them!

@johnomotani johnomotani added help wanted Extra attention is needed documentation Involves writing or updating documentation labels Dec 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Involves writing or updating documentation help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant