"Long-form" documentation
SquidDev opened this issue ยท 2 comments
As mentioned in #133, https://tweaked.cc is now in a state I'm pretty happy with. As a result, @Lemmmy and I are planning to phase out the wiki, as it's unlikely to be maintained.
However, there are some things currently that the wiki does do much better, which is "long form" articles. For instance:
- This page on
require
- Or "Network Security" (and similarly Network Attacks on the original forums)
- Tutorials
- Information on blocks/items
It'd be good to host some of this on tweaked.cc, mostly so we've got documentation in one place.
That said, the wiki "format" is probably the right thing for these sorts of docs. I think the best solution would be to write the docs on this repo's wiki, and then build it as part of the main website. I lied. While I guess it is more easy to contribute to, I do still probably want these in version control.
I'm closing this as I've done all I want to do with this. I think there's definitely room for more here, I just don't think I'm going to be the one to write it :).
So I've done some initial work on this in the above commit. It's by no means perfect - our markdown parser is super bad (but no way do I have willpower right now to roll our own), but hopefully good enough.
Now we've got to write the darn stuff! As always, would very much appreciate contributions here - events especially are pretty boilerplaty, so very much a good first issue.