Better documentation for tutor-contrib-grove

During the discussion on how to use the simple theme plugin, I started realising that tutor-contrib-grove is not very well documented.

Now that tutor-contrib-grove is split into multiple smaller plugins, I feel we should document each plugin with its own readme. While the variables are documented in the code, I think they should also be documented in the readme file for each plugin, and then the overall readme can link to each plugin and contain general information.

I don’t think this should be a big undertaking since it’ll involve mostly adding existing code comments to the readme. If this feels like something everyone will find valuable I can create a task for it.

2 Likes

+1 from me! :smiley:

What will happen to tutor-contrib-grove when we deprecate Grove, will we still need the plugins that it provides once the migration to the PHD stack is complete?

They are tutor plugins so they will still work. Some might no longer be needed so we can do a cleanup after moving, but others will still be useful.