Enhacement of docs for mahogany

[domodoiddd]

I think it would be nice to have some(even not detailed) docs for this projects, how to use it, how to customize it, may be it is really a good idea to add some init_example.lisp which will show some possible settings for this WM.
Aslo it would be nice to have at least some chat in matrix/libera.chat and others.

[domodoiddd]

I see that there is a doc folder in this repo, but I think that it is better to make links for it on README.org

[sdilts]

Thanks for the suggestion! We will definitely work to make some actionable user documentation once the project reaches a sufficient maturity level. At this point however, there isn't really anything that I think is worth writing documentation about; it's either going to change a bunch once we work on it, or is low level or basic enough that you might as well read the source code to figure out what it's doing.

To be clear, I really don't like projects that have that answer, but we will put in the work once we get farther along. Right now, if you have a specific question, I'm happy to answer it, but the answer will probably be "that's not implemented yet".

Pretty much the only customization you can do right now is change key bindings. See https://github.com/stumpwm/mahogany/blob/master/lisp%2Fkey-bindings.lisp#L44-L54.

[domodoiddd]

So some suggestions, I think that is is a good idea to:

• Write TODO list in README.org or in other file like TODO.org or may be some wishlist like it is done in stumpwm readme.org
• May be write roadmap or write roadmap before this wm will be considered stable for example
• Write or make links to stumpwm docs, if mahogany from the user point of view will be similar in terms of functions, methods, variables, even if as you say that there is not much going on here, I think that even something like this will be good for starting point https://github.com/stumpwm/stumpwm/wiki/Customize#init-file , because without looking into the code deeply at least is is even hard to understand if this wm can be customized using some init.lisp and if yes, where I should put it, what directory.
• Make init_example.lisp so that users can see what things they can already customize

Some questions and thoughts

• I see that there are some files for guix, so as understand it is already working there, I am a nixos user today, so I can port this wm to nixos easily.
• Does this wm has it's own status bar written in common lisp? Does it have any lock screen which is written in common lisp? Are there any packages which are not part of this project which implement these things? And I am interested in status bar and in lock screen which are written in common lisp because it is easy to combine emacs with common lisp programs and get better user experience.
• Does this wm has dmenu alternative written in common lisp? Or is there any common lisp code which can do it?
• I have a question, is this wm stable? I mean that it doesn't crash during the work, it doesn't have freezes or something like this? If it is stable in these terms, than I may be can install on my main system, write custom init.lisp file with my keybings, use some extra programs if mahogany doesn't have some functionality yet, may be I could help a bit, but I don't know common lisp and C well, but may be it is a good chance to practice and get some experience.
• Is it possible and is it hard to achieve something like this in common lisp https://github.com/elkowar/eww/ ? Especially interested in this https://raw.githubusercontent.com/Axarva/dotfiles-2.0/main/screenshots/center.png and in this https://raw.githubusercontent.com/adi1090x/widgets/main/previews/dashboard.png , also interesting if stumpwm has something like this.

[domodoiddd]

As I see it will be possible to have mahogany config in $HOME/.config/mahogany #57 and now it is by default locates in $HOME/.mahogany as I understand