doublespeakgames / adarkroom

A Dark Room - A Minimalist Text Adventure
Mozilla Public License 2.0
7.21k stars 1.6k forks source link

The wiki should have a guide to reading the codebase for the first time #676

Open shaenr opened 3 years ago

shaenr commented 3 years ago

A similar, less explicit issue that is quite old is this one, simply titled, Wiki.

I am a Python programmer who is not terribly great or experienced with Javascript but I know it enough to look over code and sort of figure out what it does most of the time and how to use it in small ways. As the op of that old issue said, this project probably appeals to a lot of people who are "new coders" or lack experience that they think something like could provide well

The wiki is mainly a guide on style, theme, presentation with some stuff on various things that could be added. What it lacks is, "Hello, welcome to the game and the codebase. If you have played up to this point you are ready to look at how the mechanics for what you have seen work in this file, in these functions, where you should start."

Because the game is cryptic and leaves you to figure it out, it is quite interesting, but the wiki should prepare the new contributor understand the system and how everything works and where that is defined.

Most of the code probably doesn't need elaborate, long documentation strings for every function/class/etc if you guys don't feel like you want that clutter, but what would be great is all the info that would be in those places in the wiki at least.

I know that writi9ng good docs is a lot of work. I would suggest starting with the most minimal amount of information about modules, functions, classes. objects, etc, as to not overwhelm yourself writing details.

Focus on walking a new contributor through the code base like showing someone around a new house, so that they know where things are.

If you decide to take this issue, thank you.