Dcumentation for all of Rani's Options

Apologies ahead of time if the solution is obvious. I was looking for a place where I can get a thorough explanation for each option in Rani. I’m most interested in the gaming section, but an explanation of all the options would be welcome.

I did check the wiki and (while I might have missed it), I didn’t see exactly what I was looking for. It seemed a much more general overview than a specific explaination of the options available.

I can (and have) searched the internet for each option up to this point. For example, I didn’t know what GOverlay was, so I searched for that and got my answer.

Just searching each option has worked pretty well. I was just hoping there might be some documentation I missed where it outlines it all in one place.

1 Like

Welcome to the community @Arcus. :waving_hand:

I believe the documentation still needs to be written. The application itself is not actually done yet (see this topic if you are interested in following along with the development), so I think the primary focus thus far has been focusing on that.

If anyone has experience writing documentation and would like to contribute to drafting a Rani Wiki, I’m sure that would be appreciated! Notes on how to contribute to the project are in the README on the GitLab page:

7 Likes

Yes, help with the documentation would be very appreciated! :ok_hand:

As for what you’ve been reporting regarding GOverlay: documenting every single of these apps is probably not scope of the documentation however. We simply display a list of applications here (sourced from Arch wiki amongst others).
What I can imagine is displaying the package description here instead.

4 Likes

Considering how many people work on Grauda and on RANI in particular, it will be difficult to add descriptions of individual tools. Sure, that would be nice to have, but I think it would be too much to ask and there are certainly more important things to do.

I think it should be reasonable for every user to find out things like “what does GOverlay do” with the search engine of his choice.

Everyone involved here is doing a great job - in his limited free time.

6 Likes

I wonder if it might not be possible to display a tooltip in the app that pulls from the basic package descriptions. That way, you can get some basic info about the selection by mousing over it. Obviously, they need to focus on finishing the app first. It sounds like it’s still being worked on in more important areas.

1 Like

For sure. I think they’ve done a great job. I mostly wanted to confirm that the documentation didn’t exist. Hate to be missing something obvious.

Sure, that should be possible!

It’s sadly true, rewriting it in Electron took quite a while, but was very much needed as the previously used Tauri showed massive issues due to WebkitGtk :frowning:

4 Likes

I’m still a student programmer but if I can help with something like that, I’d definitely be open to it.

I would assume that tooltip functionality is something that already exists and just needs to be specifically called for in the code? That’s just a guess as I don’t know anything about the code, but it’s pretty basic functionality.

3 Likes

I remember trying Garuda a year to two ago and really liking it but the old assistant app was very different from this new one. The new one looks great. I would agree that it was definitely worth it.

3 Likes

Hey, if you feel like contributing, that’s always welcome :grin:
Code should be all available, pTooltip of primeng comes to mind. Descriptions for packages should also be around already iirc. To me it seems easy to implement. And of course I can provide directions of needed!

Creating a new app was a first step a while ago. But it turned out that Tauri on Linux (the already new base) had before-mentioned flaws, so the already new app had to be ported again :upside_down_face: but.. still very worth it :yum:

6 Likes

This topic was automatically closed 2 days after the last reply. New replies are no longer allowed.