carenalgas / popochiu

Godot plugin to make point n' click games in a similar way to tools like Adventure Game Studio and Power Quest.
MIT License
159 stars 17 forks source link

More robust project documentation #147

Closed stickgrinder closed 4 months ago

stickgrinder commented 6 months ago

Benefit description

Popochiu outgrew the incubation stage and now requires better, more mature documentation that:

From a content point of view:

Solution description

We scouted for a solution and decided to go with MkDocs for it's natively supported by RTD and can be easily deployed on GHPages.

Also, compared to Sphinx, it uses MarkDown, and its configuration is a single YAML file.

The todo-list follows:

Exclusions

We're not going to create a custom theme. We'll customize the logo and colors, and that's all.

Implications

This will allow contributors to add content without access to the project's wiki repo, which is way more problematic.

stickgrinder commented 4 months ago

I'm closing this because I split some tasks in more granular issues.

The bulk of the docs framework is done, it's now time to move on with the content.