For the 2024 Hackathon, @JorisDarlingtonQuarshie and @TBurmeister want to make it easy for tool developers and technical contributors to improve tool documentation. To facilitate that, we're working on the following coordination tasks:
[] Creating a project page under https://www.mediawiki.org/wiki/Wikimedia_Hackathon_2024/Projects
[] Reviewing existing Phab tasks and identifying those that are relevant for tools and appropriately scoped for hackathon work; tagging them with #wikimedia-hackathon-2024 and #Documentation
[] Investigate methods for identifying tools that could use documentation or maybe have it but it's not easy to find, maybe https://toolhunt.toolforge.org can be useful here
[] Creating (or updating) guidelines about:
-- [[ https://www.mediawiki.org/wiki/Documentation/Contribute/Filing_documentation_tasks | how to file good docs tasks ]]
-- what is [[ https://wikitech.wikimedia.org/wiki/Help:Toolforge/Developing_successful_tools#Write_some_docs | essential documentation for tools ]], focusing on README and CONTRIBUTORS contents, like a "how to run this tool" section
-- how to find and improve existing tool documentation
-- how to invite contributions for tool documentations for tools you maintain (building on discussions at past hackathons like T332876, T333178, and
For practical reasons, we're limiting the scope of this to active tools available on Toolforge, with preference for community-maintained tools. And we're focusing only on technical documentation -- not tool user documentation. If you know of actively-maintained or still-functional tools that could benefit from improved technical documentation, you can contribute to preparing this hackathon project by filing phabricator tasks and tagging them as described above. If I have tagged a task that you think doesn't meet our criteria, or you want it removed for any reason, please remove the tasks. Thanks!