[Scummvm-devel] Google Season of Docs

[Matan Bareket]

Hello team,

As you may have seen in Discord, Google is hosting their 2nd "Season of
Docs" this year and applications are now open.

Season of Docs has similar goals to Summer of Code, but instead of pairing
an open source project with student developers, they are paired with 1 or 2
technical writers to help improve technical documentation in return for
real project documentation skills.

There are a few projects that would benefit the organization:
* Refresh of the ScummVM manual - This task would collect the various
pieces of information from the README, Wiki, and ports and help organize
them in a new portal. The new portal can be based on either Markdown or
ReStructuredText and will allow us having versioned manuals for ScummVM in
a format that's easy to edit and distribute

* Doxygen refresh - Our doxygen page is nearly useless - parts of the API
aren't properly documented, long deprecated content is still around, and
generally important pieces of code seem to be missing documentation. The
project will focus on modernizing and updating our Doxygen site,
potentially integrating it into the new docs portal as a future goal

* Wiki maintenance - A simpler task, cleaning up the wiki where it's
outdated, standardizing pages to be consistent, etc.

Each TW requires a commitment of two mentors and the organization gets a
small stipend per TW mentored by our org.

The deadline for application is May 4th, with the program official starting
September 14th, so we will not have an overlap with GSoC.

Please reply back if you're interested in mentoring, or if you have other
project suggestions for a TW to tackle so I can put it up on the list.

In the meanwhile, I've started a Wiki page here:
https://wiki.scummvm.org/index.php?title=Season_of_Docs
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.scummvm.org/pipermail/scummvm-devel/attachments/20200419/2bf8ddce/attachment.htm>