76
edits
Difference between revisions of "Season of Docs/GSoD Ideas"
Jump to navigation
Jump to search
Additional task details
m (Mataniko moved page GSoD Ideas to Season of Docs/GSoD Ideas without leaving a redirect) |
(Additional task details) |
||
| Line 27: | Line 27: | ||
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 | 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 | ||
As part of of this task, you and your mentors will work on: | |||
* Launching a new documentation portal (Docusaurus or readthedocs.io) | |||
* Consolidate existing documentation efforts | |||
* Define user journeys, document ScummVM's features, and create relevant manuals and guides. | |||
=== Doxygen Refresh === | === Doxygen Refresh === | ||
| Line 34: | Line 41: | ||
Our doxygen page is woefully outdated - 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 | Our doxygen page is woefully outdated - 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 | ||
As part of of this task, you and your mentors will work on: | |||
* Understanding the ScummVM code base and identifying important undocumented functions and classes | |||
* Improving the existing doxygen templates (https://doxygen.scummvm.org) | |||