76
edits
Difference between revisions of "Season of Docs/GSoD Ideas"
Jump to navigation
Jump to search
m
no edit summary
m |
m |
||
| 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: | As part of of this task, you and your mentors will work on: | ||
| Line 33: | Line 32: | ||
* Consolidate existing documentation efforts | * Consolidate existing documentation efforts | ||
* Define user journeys, document ScummVM's features, and create relevant manuals and guides. | * Define user journeys, document ScummVM's features, and create relevant manuals and guides. | ||
* Refresh the outdated User Manual | |||
=== Improve source code documentation via Doxygen === | === Improve source code documentation via Doxygen === | ||
| Line 41: | Line 40: | ||
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: | 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 | * Understanding the ScummVM code base and identifying important undocumented functions and classes | ||
* Improving the existing doxygen templates (https://doxygen.scummvm.org) | * Improving the existing doxygen templates (https://doxygen.scummvm.org) | ||
* Increase the consistency of coverage of our common, audio, backends, graphics, gui, images, video and engine code docs. | |||
* Clean up old, irrelevant documentation | |||