HSM has a docs problem

[samualtnorman]

And I don't really know the best way to approach it.

Do we go all in on making --help really good?
Do we use GitHub's built in way to make a wiki for a repo?
Do we make a docs website? Maybe https://samualtnorman.github.io/hackmud-script-manager/?
Should the docs source be in this repo or a separate repo?

Need a list of stuff to document and a system for organising it for ease of access.

[samualtnorman]

the docs could also have a Known Problems and Workarounds section as well as tips and tricks for squeezing the most out of the minifier

[SarahIsWeird]

My two cents: First thing I look for when searching for documentation on a GitHub repo is the wiki tab. Second thing is some link somewhere named "Documentation" in the README.

Having --help be good is a nice bonus, but I hate having to install things to figure out if it fits my usecase.

[samualtnorman]

wiki tab seems like an obvious choice, I have seen multiple projects start using it and then switch to a different solution though. on the other hand, whatever problem/limit they hit that causes them to move could be a bridge for us to cross when we get to it

[samualtnorman]

the wiki tab is open!
https://github.com/samualtnorman/hackmud-script-manager/wiki
at the moment, it's open for anyone to edit. I'll see how this goes