chore: transfer docs on module configuration (a subset of the module docs)

[arikorn]

These files reside in a subfolder of module development.

All are lightly edited.

(Some current files were edited.)

Note there are some TODOs that I put in for Julian to address in updating-node-js

[Julusian]

Im not sure this label/grouping is entirely correct, as under here is various topics such as 'updating nodejs' and 'companion module libraries'

tbh I think it might be best to split this up into a few categories:

• module files (or module structure?)
• module maintenence (update node, module libraries)
• code quality (linting, formatting, unit testing)

[arikorn]

Yeah, I think that's closer to how it was originally organized... but the thing is: all of these pages discuss specific, global files in the repo, rather than how to add module-specific functionality, so in my mind they are really about setting up the the repo before you start coding.

That said,

• we could combine lint and prettier pages and call it "code quality" (still in this section). On the one hand, the two are closely related -- as you note in the eslint page. On the other hand the eslint page is quite long now... I don't particularly think of these as a "code quality" section, since the pages are not so much about code quality advice but rather, setting up repo tools.
• the unit-testing page probably doesn't belong in this section since it doesn't describe a global file (and anyway it doesn't really recommend anything). It would make more sense to be here if it recommended a testing tool and how to set it up.
• "updating node.js" probably belongs as a postscript to the manifest.json page, perhaps as its own page just under manifest.json, with my '- filename' "indentation" trick. Or as you suggest in a maintenance or "module lifecycle" section (which would be a bit more inclusive).
• The "libraries" pages could swing either way since it covers both the current libraries (belongs here) and when to update (a maintenance section)...

Finally, the whole subsection could probably be called "Module Structure" but originally the page called "Essential Files" was called File Structure (which is still its filename), so I chose a different name.

What do you think?

[Julusian]

I suppose that my thinking of breaking it up is because I see this as being different difficulty levels.
If you are a non-developer trying to make a module, you arent going to want to go near many of these topics, but the general file structure information is something they should read.

Or at the very least, they aren't something you need to know to immediately get started, they are tasks for after making a POC and proving that the module is possible to make.

we could combine lint and prettier pages and call it "code quality" (still in this section). On the one hand, the two are closely relate

true. that sounds like a good idea, and would mitigate this a bit

[arikorn]

OK, see my latest attempt. (Details in the commit message.)

[Julusian]

ok, Ive done a read and rewording pass over this finally

let me know what you think on the comments

[arikorn]

In the individual replies, above, I've attempted to make my thinking/motivations a bit clearer. That said, if you still prefer to stick with your suggestions, just say so! I'll wait on your replies before continuing either way.

[arikorn]

OK, my latest changes to this section were a bit more extensive than I had anticipated, but I think the docs are better for it.

What do you think?