Documentation / Wiki update

[the-j0k3r]

Our contributing.md and general readmes, is now mostly obsolete. ORG wide issue in 99% of repos not just this style.

• [x] Needs rewrite to account for existing actual requirements for new contributors.

• [x] K.I.S.S My biggest gripe with anything especially in this repo, is that is beyond complex for new contributors.

• [x] Remove requirements like (Don't add any inline comments. If you want to make a comment, add it as a note in the commit message.), Some ppl doesnt read commit messages or blame (Blame is now working again on this repo)

• [x] In this repo (Github Dark) it needs to document the generator, in fact theres no docs for generator at all. Only 1 person knows the generator inside out. Dont even get me started on new contributors and contributions. People should read and understand where and how to make a contribution using the PRIMARILY the generator, secondary manual entries.

• [x] build.json entries in contrib.md? Never worked, its gone, I never even when it worked made my contributions based on that

• [x] We dont use USO, Stylish or have grunt for some, the list of requirements and other portions all obsolete and all account for obsolete needs.

• [x] Readme needs a once over also new screenshot, perhaps a gif instead of a static image even.

• [ ] Wiki, yea, that too.

• [ ] Etc

related to https://github.com/StylishThemes/GitHub-Dark/issues/1166#issuecomment-653840137

[the-j0k3r]

Some updates in https://github.com/StylishThemes/GitHub-Dark/commit/afc7f27fb9a00a08615d3c0f7af0b317a8977b5d and https://github.com/StylishThemes/GitHub-Dark/commit/0c4453f02eef89d97e2014377c0f5ec37f100227

This is still largely Not OK

Some of the un-edited entries need reformulating to make them beginner friendly. aka K.I.S.S

@xt0rted if you have time to cleanup lingo would be great. Else will have to wait indefinitely.

No checkboxes have been ticked in the list above, mainly cause, well, its still a large mess even if its less now its still not fine.

[silverwind]

Happy with any simplifications/clarification but I wouldn't bet on contributions, those have always been rather non-existant, probably because of the complexity which we can not really reduce easily.

[the-j0k3r]

Hence docs, clearly ppl need to know how this works. I dont think more contributors will multiply overnight, but without docs none knows how to contribute, what to edit etc.

In this case the generator, what to follow and do when contributing fixes via generator etc.

[silverwind]

I'm thinking about just nuking CONTRIBUTING.md, it's way too verbose and https://github.com/StylishThemes/GitHub-Dark#development is all needed info really.

[the-j0k3r]

far from it, well far from it

Theres no generator info, no way how it works no explanations of anything. No steps to follow for first timers, nothing.

, and you think its OK?

Ill agree contributingMD is mostly obsolete, and nuking it is not a bad idea, but at least include proper info. As is, thats not it.

[the-j0k3r]

We should include this also

These special mapping keys supported:

- `$border: value`: Any occurance of `value` in a `border` rule.
- `$background: value` Any occurance of `value` in a `background` rule.
- `$box-shadow: value` Any occurance of `value` in a `box-shadow` rule.
- `$color: value`: Any occurance of `value`.

and some info that tells ppl where to add/edit those values.

WE simply must document how the gen works, provide that info in a simple way and not making it hard to contribute.

[the-j0k3r]

Following https://github.com/StylishThemes/GitHub-Dark/commit/cad6a0f1487da33c44254713b6aa9da90f25550b Only the wiki and odds and ends needs TLC