iris-grib icon indicating copy to clipboard operation
iris-grib copied to clipboard

Reprioritise documentation

Open pp-mo opened this issue 5 months ago • 1 comments

We still have very limited documentation, discussion (as opposed to API) is still just one page.

But even in one page, we don't have decent clarity of organisation.

There are some very obvious things people need to be able to find.

  • what does iris-grib do
    • and what does it not do (limits of translation)
  • what is the relation to iris
  • what can you do to work around problems (fix load errors)
  • how do you ask for help
  • how do you ask for improvements

And, in all this, a prominent TOC would make a huge difference

Fixing this, without adding anything much (and maybe staying within 1 page), could be a pretty small task.

pp-mo avatar Jun 12 '25 15:06 pp-mo

To quote myself before I forget it again:

Low resourcing makes documentation even more important:

  • Can be a surrogate for user support
  • Can help people work around problems while they're waiting for a fix
  • Can help people contribute where we can't make the time to do it ourselves
  • Even core devs are likely to be rusty / have shallow expertise, so anything that's helpful to open source collaborators is equally helpful to core devs

trexfeathers avatar Jun 13 '25 09:06 trexfeathers