Docs Time!

[jlord]

This PRs adds and updates the docs for real life, all grown up, out in the real world!

• CoC
• Update readme
• Application documentation
• Issue templates

[jlord]

Over the weekend I was like this should totally have a diagram...and it's probably diagram-able, I'll do that. So I tried, I got this, and I'm not sure if it's worth including (is it even helpful?) something like this or in which ways it can be refined to actually be helpful to people? cc @simurai

[simurai]

Nice! 👍 Ya, I think it's helpful understanding the directories and how things get loaded.

But this wouldn't be part of the content, it's specific to this demo app, right? Would it be part of the README.md? For people that try to understand how the demo app is built.

[jlord]

Would it be part of the README.md?

I was thinking of having it a part of the docs.md file?

[simurai]

Ahh.. yes, that makes sense.

[jlord]

I'm going to change some of the colors so that it matches the app itself a bit and then this should be ready for merge.

[jlord]

Ok, I've updated it to make it match the app more. I've also added a bit more to the diagram, like numbers! Still not sure if my endeavor to graphically explain these types of things is worth it (in this case in beyond!). Six is repeated because these two things happen together 😁

@simurai how do you feel about the quality of this graphic? Do you want to mess with it? I can send you the .ai

@kevinsawicki do you think it explains the process correctly?

[kevinsawicki]

do you think it explains the process correctly?

Diagrams looks great.

One small question, should there be two step 6s? Or should they be 6 and 7 instead?

[jlord]

should there be two step 6s? Or should they be 6 and 7 instead?

Yeah, so I wasn't sure what to do there because these two things are happening at the same time really.

Now that I'm thinking about this again, lemme try and move some things around so that the two blocks of text can be together with just one number.

[jlord]

Ok, how about this?

[jlord]

And thinking about it some more, it doesn't make sense to differentiate the assets with a different color. Event though it contains non-js and non-html, everything in it belongs to the renderer process.

[simurai]

I think looks great. But if you post the source file, I can fiddle with it a bit too.

Maybe try to make the connection between the arrow, number and text more clear. Not sure how.. would have to try it first.

[jlord]

Kewl, I'm going to 📧 it to you because I don't know if you prefer GH Box or Dropbox or if putting it in the repo is good/bad. I'll send it to you and let you decide 😀

[jlord]

Updating with @simurai's iterations (thank you!) :

---

I like the first one cause it's nicely sorted, though I'm not sure if having to match up the words with numbers is extra mental load? Maybe it's negligible?

What do people think?

[simurai]

having to match up the words with numbers is extra mental load?

It probably is extra mental. In the 2nd version you can move in a circle around it, so maybe still better?

[jlord]

In the 2nd version you can move in a circle around it, so maybe still better?

Yeah, that was something that I liked worked out when I was iterating on it. Let's go with that, you're second one. I'll add it to this branch.