TrustedUser
2,147
edits
Difference between revisions of "Season of Docs/GSoD Ideas"
→Launch a Documentation Portal: Add links to README and User manual
(→Tasks: Adding myself to the list of contact) |
(→Launch a Documentation Portal: Add links to README and User manual) |
||
| Line 29: | Line 29: | ||
Difficulty level: Medium-hard. Might require some basic development skills if we opt in for something like Docusaurus | Difficulty level: Medium-hard. Might require some basic development skills if we opt in for something like Docusaurus | ||
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 [https://github.com/scummvm/scummvm/blob/master/README.md README], [[Main Page|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 35: | Line 35: | ||
* 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 | * Refresh the outdated [[User Manual]] | ||
=== Improve source code documentation via Doxygen === | === Improve source code documentation via Doxygen === | ||