shiro icon indicating copy to clipboard operation
shiro copied to clipboard

Published 20 hours ago • verified publisher icon mellowagain

Create documentation and start documenting Shiro

Open mellowagain opened this issue 7 years ago • 2 comments

Shiro itself has no documentation apart from the README.md file, which briefly describes how one would build and start Shiro.

There is no in-depth documentation on how to setup Shiro and its modules, how to get osu! clients to connect successfully and how to contribute. If we want Shiro to be adapted widespread, documentation is key.

I thought about implementing some sort of documentation using Sphinx and https://rtfd.org. The problem with Read the Docs is that shiro.rtfd.org is used by some other project already. However, osushiro.rtfd.org or shiroosu.rtfd.org is still available. I'm rooting for the first suggestion.

mellowagain avatar Oct 07 '18 15:10 mellowagain

@cyanidee have decided on osushiro.rtfd.org. I've revamped the README.md in e10e3c01bb39971aa35bd5fd61ed39c2a9ac3953 to reflect this decision.

mellowagain avatar Oct 08 '18 20:10 mellowagain

We've changed from rtfd to using GitHub Wiki. Some documentation has already begun over at the wiki.

mellowagain avatar Jun 16 '19 21:06 mellowagain