Clue icon indicating copy to clipboard operation
Clue copied to clipboard

Docs

Open Enn3Developer opened this issue 2 years ago • 1 comments

About docs, I'm not talking of the wiki (although that needs some rework) but about the codebase. If one wants to start contributing to the project they need first to understand the code they'll work on, and the best way to learn about the code is to read what the code does. Reading the code as-is may be something really difficult, here's why there's the need of documenting the code: to make the life easier to people that want to contribute on the project.

Enn3Developer avatar Jun 18 '22 13:06 Enn3Developer

I don't think I can document the code myself as im not really great at explaining things

Maiori44 avatar Jun 18 '22 13:06 Maiori44

Should this be done for 3.0?

Maiori44 avatar Nov 09 '22 08:11 Maiori44

Yeah, prob after the type system

Enn3Developer avatar Nov 09 '22 08:11 Enn3Developer

I'll add the milestone then

Maiori44 avatar Nov 09 '22 08:11 Maiori44

Now that the types were delayed...will this be delayed too or?

Maiori44 avatar Nov 18 '22 17:11 Maiori44

nah, maybe I'll do this one after I'm finished with the optimizations

Enn3Developer avatar Nov 18 '22 17:11 Enn3Developer

Alright

Maiori44 avatar Nov 18 '22 17:11 Maiori44

Since 3.0 is huge and 3.1 is gonna be a sort of "doc and lib" update..maybe this should be delayed to 3.1?

Maiori44 avatar Nov 28 '22 09:11 Maiori44