Walkthrough Videos / Blog Posts

[LGUG2Z]

It would be nice to have videos or blog posts (any in language) of people walking through their configurations and showing their workflows using komorebi. These could all be added to a "Media" section in either the readme or on the project Wiki.

Since these kinds of walkthroughs are always more approachable than a big README.md, I think it would go a long way to improving the onboarding for potential new users who are interested in trying out a tiling window manager on Windows 10+.

If you have produced any content like this about komorebi and come across this issue, share a link here so that I can get it added to the documentation for more people to see.

[worldofgeese]

Just as an example of new user confusion, I still don't understand how to manage multiple monitors and their workspaces despite setting

; Ensure there are 3 workspaces created on monitor 1
Run, komorebic.exe ensure-workspaces 1 3, , Hide

On the secondary monitor and attempting to create a bind for send-to-monitor 1,

[snide]

Hey. I'll sign up for this. I just found komorebi today and am absolutely thankful that it exists after coming from I3 in Linux land. Give me a little time to learn the configuration files and then I'll try to post something up.

Here's some previous videos I made around similar geek-config applications

• NNN https://www.youtube.com/watch?v=-knZwdd1ScU
• Flavours https://www.youtube.com/watch?v=y-GERsrhTkA

[LGUG2Z]

Hey @snide! I'm very excited to see your video! Feel free to join the Discord to ask questions or open issues for anything that I can help with while you're getting familiar with the project. 🙏

Funnily enough, I also maintain an open-source Elasticsearch project, what a small world!

[snide]

Small update. Shot the video work last night. Will spend the weekend on editing and get this to you hopefully by Monday.

[namefailed]

@snide poke

[GOATS2K]

This is the video in question.
https://youtu.be/bf0j4GpubXA?t=187

[LGUG2Z]

I have started doing YouTube livestreams on komorebi development which will hopefully showcase more and more of the more advanced features as they undergo development and refinement. If you'd like to be notified of future livestreams or when videos of past livestreams are made available you can subscribe and register for notifications.

[Rafael-Conde]

I have started doing YouTube livestreams on komorebi development which will hopefully showcase more and more of the more advanced features as they undergo development and refinement. If you'd like to be notified of future livestreams or when videos of past livestreams are made available you can subscribe and register for notifications.

I started watching one of them and I liked it! I couldn't make it to the end though, I'll finish it later.

I have a suggestion but maybe it's just me being lazy. I would really like to start using komorebi on a daily basis, it's the first window manager I use so the experience is still suboptimal due to my lack of experience. I think that it would help me if there was a config file with shortcuts to all komorebi functions. I believe I'm just being lazy, but not having to deal with configuration up front would allow me to just use it before trying to make it fit my personal pereferences.

The current sample in the repo is actually pretty good in my opinion, it might be that people that uses window managers with shortcuts would also likely use vim/neovim too, so I really appreciate the sample, I already used it for a bit and I could do a lot with it. Despite of that, I think I couldn't laverage the whole potential of komorebi.

I understand that this issue is supposed to help in that regard, but since I didn't see it explicitly mentioned in this thread I thought I could highlight it.

[LGUG2Z]

Thanks for the feedback @Rafael-Conde! I will plan a livestream where I can interactively go through this file which contains all of the commands that you can bind to a key combination, show myself adding things from that file to the komorebi.ahk, explaining what each command does etc.

[Rafael-Conde]

Thanks for the feedback @Rafael-Conde! I will plan a livestream where I can interactively go through this file which contains all of the commands that you can bind to a key combination, show myself adding things from that file to the komorebi.ahk, explaining what each command does etc.

That would be awesome @LGUG2Z ! One thing I believe I can do too is use your video and sort of turn it into a table with the commads, functionality and maybe even link the video timestamps into the table for reference and examples. Do you think it would help?

[NormTurtle]

this file
404

[LGUG2Z]

https://www.youtube.com/watch?v=cBnLIwMtv8g quickstart walkthrough by me is now on YouTube! 🎉

[d-r-a-b]

Just found out about this project and it looks very interesting. The quickstart video was very informative!

One thing I noticed is that figuring out all the komorebic commands right now seems to boil down to looking at the configuration examples and using the komorebic command directly - did I miss a doc/blog post/video guide somewhere that covers these? It would be nice from the standpoint of a new user trying to get a more concrete sense of the features offered by a piece of software without having to first install that software. For example, I couldn't find anywhere that documents what monocle mode is, even if I could infer that it was probably a maximized window mode from the komorebi playlist videos. Seeing a set of "resize" maps in the example whkd config is the only reason I could guess that komorebi supports this, and I don't see any obvious way for a potential user to tell if there is the ability to dynamically create/destroy workspaces or to see all apps in a similar way to MacOS Expose/Windows Task View.

I spent 25 minutes looking for such docs, so this might be a personal problem but it is a datapoint relating to the onboarding experience. If such docs aren't available, new users would spend less time looking for the docs if there was a statement that such docs are a WIP/wishlist/unmaintainable item for now as komorebic is in active development and the only way to explore the features more in depth is to install and run komorebic or look through the source. I habitually prefer to install only software that I'm reasonably certain has the features to solve the problems I'm facing, perhaps as a side effect of the trauma of Windows registry/config file nightmares and a desire to reduce the malware attack surface inherent in installing more software packages. (Not saying that komorebi itself is any kind of security concern, but rather that a mindset of "install the software and find out" is not a good scalable solution and most users would be more secure if they did not just install any software package that hinted at solving their problem)

Funnily enough, the Chinese README does include a (non-comprehensive?) list of komorebic commands that succinctly provides a sense of komorebi features. Would you be open to a documentation PR that basically just translates that table to English and inserts it in the README?

[LGUG2Z]

The Chinese readme is actually based on an older version of the English readme. 😅

I agree with everything that you've said @d-r-a-b, and I think that we should redirect these efforts towards a project Wiki on GitHub, which has proven very beneficial for yabai.

I'm currently facing some health issues that limit the amount of time I can spend sitting at a computer, so I'm not in a position to take the lead on this, but the Wiki for the project is open and I encourage anyone who would like to contribute to the project to start adding pages using the yabai Wiki as a good reference model.

[d-r-a-b]

Sorry to hear about the health issues and hope they improve/become easier to manage with time. Thanks for the quick reply offering some direction on how contributors can help with this!

[LGUG2Z]

I have added an auto-generated HTML version of the schema.json file for the static configuration format: https://komorebi.lgug2z.com/schema_doc

[goyalyashpal]

I think that we should redirect these efforts towards a project Wiki on GitHub, which has proven very beneficial for yabai.
- @ LGUG2Z at #18 (comment)

... have videos or blog posts (any in language) of people walking through their configurations and showing their workflows using komorebi ...
Since these kinds of walkthroughs are always more approachable than a big README.md,
- @ LGUG2Z at #18 (comment)

i don't think that either of the proposed direction is good:

• using community walkthroughs
• using github wiki
• for this purpose of "beginner oriented getting started guide"

to be clear, using community submissions on gh wiki is good idea - it's just not good (rather, very bad even) to use those for this purpose.

---

so, to make readme more approachable, i would propose to split readme in different sections.

i would be able to make a merge request for that if it's wanted 😃

[LGUG2Z]

This is probably the best walkthrough video I've seen so far made by Olge on Discord!

https://www.youtube.com/watch?v=0LCbS_gm0RA