5
The Unofficial Guide to /kbin updated with better navigation and added images to the home page!
(media.kbin.social)
The Unofficial Guide to /kbin updated with better navigation and added images to the home page!
https://kbin.social/m/unofficial_kbin_guide/t/431615
#kbin #kbinmeta #kbinhelp #kbinguide #kbinMeta
@ernest @unofficial_kbin_guide I think a dedicated website like this kbin guide is indeed the way to go. Codeberg wiki is limited in several ways. Making this guide somehow part of an official project / documentation would be great. @unofficial_kbin_guide You agree?
@melroy @ernest I do not have a codeberg account. I would have to get that set up and get back to you. As for the best place for the docs to live, I would say that you both are right (cop-out answer, I know). Here's why:
To be fully searchable, but only bring relevant guide results the docs should be their own package (I really did not see a way off hand to search the codeberg wiki). To engage the users the docs should be easy to navigate, easy to search, and easy to read. As for the wiki, I am not super familiar with codeberg, but the wiki does look limited. I am not sure if Codeberg comes with a "pages" option like github.
However, https://unofficial-kbin-guide.surge.sh/ is built in markdown using mkdocs material. So, the current repo https://codeberg.org/Kbin/kbin-docs could be repurposed to hold these files and set up to deploy on pr merge. Take a look at https://docs.codeberg.org/ and https://codeberg.org/Codeberg/Documentation for example. I would not tie doc updates with code releases so we do not have to wait on code releases to deploy doc updates.
I would advise to serve the published docs outside of codeberg since not all (maybe even most) of kbin users are not necessarily developers. So, I would serve the content somewhere like https://kbin.pub/en/docs or at https://kbin.social/docs. If choosing kbin.pub we will have to make a clear distinction between "user" docs and "developer/server" docs. Also, if using kbin.pub ... then the help column on kbin.social (as well as other kbins) must be updated to point to the new docs.
I am happy to help. Let me know your thoughts.