💡 [FEAT] better documentation -> fonts and config files

[JindrazPrahy]

I had trouble understanding how to set up dooit, namely with two things (and I still am not sure if I understand it)

1. Getting the fonts to work

Emojis make up the graphics in dooit, so I think they are integral to the program. Yet fonts aren't in the dependencies (for understandable reasons). Still, I think it would be good if the project indicated (i. e. in the README) which font is preferred and perhaps how to make the emojis work in a terminal setting, where it's monospace. (While looking through the source code I found a comment saying nerd fonts are preffered? Still, I don't think reading the source code should be required for users.)

2. Understanding how to change the keybindings

My current understanding is that keybindings are stored in a file called config.py? It's highly unusal for a config file to be a .py file. Imo this should be stated in the wiki:
https://github.com/kraanzu/dooit/wiki

I also think it might be a good idea to fill the config.py with the default keybindings so that the user can just easily change them and doesn't have to worry about the syntax.

To sum up, this feature request is to somehow indicate how to do those things somewhere in the project so that it's easy to find.
It might be even considered a bug report.

[kraanzu]

Hi @JindrazPrahy ,

Thanks for opening the issue!

Getting the fonts to work

In the previous version, I directly used nerd fonts because I didn't think many people will use it haha but this issue was raised time and again so I replaced all the default icons with unicode icons from this site which I think should be present by default in any system?

It's highly unusal for a config file to be a .py file.

Yes I guess that might be true

I also think it might be a good idea to fill the config.py with the default keybindings

I think this can be a great idea. Maybe you can do something like dooit example which will create a default config with all the default settings in it!?

[JindrazPrahy]

Hi,

fonts:
The link you sent doesn't work for me, although I assume it's a unicode table.
I don't think that every system has every unicode symbol, you have to install them separately (for example you can download a font for Japanese kanji, but it's not present by default on every system).

Also, each font has a slightly different version of every letter.

Some of the issues that can arise
a) a user is missing some emojis and doesn't know which ones, since they are displayed as a box
b) dooit uses emoji A and emoji B. User has font a which implements emoji A, but not B and font b, which implements emoji B, but not A. Thus emojis A and B look jarring next to each other (ex.: one is in color and the other in black and white)
c) User has font a and font b and dooit uses font b. User wants to keep font b, but wants dooit to use font a. User doesn't know how to switch.

Issues a) and b) could be (at least partially) solved if dooit indicated (i. e. in README), which fonts can be used for which emojis, like a reference font. I know this is technically not an issue with dooit and dooit can't help with every issue tangentially related to dooit. But I think it would be nice and not difficult to include this reference font that implements all emojis used in dooit.

For issue c) (and a) + b)) I think it would be beneficial if community contributions were somehow enabled on the dooit wiki and users were encouraged to post there. Idk how that's done and if it increased the maintenance burden, this might be an argument against it.

Keybindings:
dooit example seems like a great idea in case a user loses their config. Though this seems somewhat inconsistent given that "man dooit" and "dooit h" both do nothing. When I use a bash program that outputs files, I expect it to have a man page or at least a -h flag that tells me what it outputs.

Implementing dooit -h and man dooit doesn't seem too difficult though? I don't know how to do it and I've never done that, but since there already is a help screen in dooit, it doesn't seem to me like a big problem to implement it - maybe it would be difficult to maintain it.

Even if dooit example were a thing though, I'd still think it would be a good idea if config.py had the default keybindings in there by default (and if it was indicated on the wiki that config.py is the config file, currently the wiki just says what the config directory is).

[kraanzu]

I understand! Thanks a lot for the detailed explanation!
I'll do the implementations!

I'm currently working on optimizing and refactoring the UI so I'll start working on this a few days later!

[Justinzobel]

I am also finding it hard to figure out how to enable the dashboard for Overdue/Current/Done tasks.

[kraanzu]

Hey @Justinzobel, can you explain? Do you mean the details in the bottom bar?

[Justinzobel]

Hey @Justinzobel, can you explain? Do you mean the details in the bottom bar?

This one https://user-images.githubusercontent.com/97718086/221467485-fae198f7-51b1-4a71-91d9-88b51897aeeb.png is what I'm trying to achieve but even with 4 workspace setup, some tasks set as complete, some with due dates it doesn't show up. I think I have to add it to a config but I'm confused by the instructions.

[kraanzu]

Ah yes, currently you have to do a lot manually to get the count of tasks. I'll try to implement something which will make it easier to fetch and filter them

[kraanzu]

Closing this as now dooit uses regular unicode and has a separate repo for extra eye candy!

[github-actions]

Did we solve your problem?
Glad we could help!

Consider sponsoring my work through github sponsors 😄
– @kraanzu