Fedilab is full of features and unfortunately it suffers from a lack of documentation describing them.
Currently, we don't know how to act with that issue. We don't have resources to write all this documentation.
Asking help is not so easy. We need persons knowing the app and that are familiar with dev (git + Hugo gohugo.io/)
We could create a fundraising for that issue but we will need advice for a such project.
Don't hesitate to share that message, thank you.
The world's fastest framework for building websites
Hugo is one of the most popular open-source static site generators. With its amazing speed and flexibility, Hugo makes building websites fun again.gohugo.io
Leela Torres
in reply to Fedilab Apps • • •Fedilab Apps
in reply to Leela Torres • • •Yes, it could be a nice alternative.
crazyeddie
in reply to Fedilab Apps • • •@LeelaTorres There's also sphinx and git book.
I really like Sphinx as wrapped up in Jupiter Book.
I've been looking for a good way to sort of merge them so I can have a book within a blog site, and then I'd use Hugo for that. Right now though I just have cobbled up a blog with ablog, some other Sphinx plugins, and copying some people online.
deutrino
in reply to Fedilab Apps • • •@LeelaTorres I'm interested in contributing and I love wikis
my problem is that I can never be sure when I'll be able to contribute, because I can't predict when I'll have the mental bandwidth to focus on complex work, so I can't make promises
as a result, I'm most likely to contribute over time when there's a social aspect to a project which reminds me that it exists and that I intend to work on it. is there a chat channel for the project?
Marcel
in reply to Fedilab Apps • • •At least from the source code + screenshots it should be able to create docs. Fur sure not good docs but better than nothing.
'Alpha' docs 😁
Captain Steph
in reply to Fedilab Apps • • •Knut 🏳️🌈 🇳🇴🧸
in reply to Fedilab Apps • • •Hoople
in reply to Fedilab Apps • • •draeath
in reply to Fedilab Apps • • •start requiring at least an outline of documentation for new features before accepting them. It doesn't need to be great, but it's at least something to form a starting place for someone to fill out.
It sucks, but something like that really needs to be done in significant projects that don't have people already in on documenting things.
Escapist 🇪🇺
in reply to Fedilab Apps • • •Julien Colomb
in reply to Fedilab Apps • • •my 2 cents:
- get a list of these features you want to document.
- create videos to show the features. that is faster for your team to produce than proper text documentation.
- Ask for volunteers to transform the videos into documentation.
plan your documentation to be multi-language and screen reader compatible.
-> hugo has some good templates for that I think. alternatives: quarto, jupyterbook2. (the R bookdown is just an implementation of hugo). (disclaimer: I am not an expert, this would need some research / asking around)
Nova
in reply to Fedilab Apps • • •If any of my techy friends on here could lend a hand or just share this, it would mean a lot to me. A lot of people (myself included) have a hard time narrowing themselves Into one instance and rely on GUIs like this to manage all their mastodons at once. It makes the fediverse a more accessible place.
#fedilab #calltoaction #FOSS #fediverse