Documentation suggestion for better adoption

[bedge]

I've spent a weekend on this and I've isolated the pain point, for me anyway. I'm right at the cusp of this being workable and can taste the benefit it provides, vs. tossing it all as I'm back at work on Mon.
Exceeding a weekend's effort is, IMO. the kiss of death for a utility one wants to "try out".

I'll summarize by comparing the schema docs to javadocs and the notion of pointing end users to javadocs.
These are great for win32 devs, but for us Linux/Mac folks that have no clue what a "Win32 Rect" is, some descriptive text that assumes we know nothing is needed.

Adding a follow on to the dev targeted text for users that are not Win32 devs would make the adoption much easier.

Lastly, please add a field in the schema docs for whether it requires a restart, vs just saving the file.

[LGUG2Z]

Exceeding a weekend's effort

Honestly, I'm pleasantly surprised by this number considering that it takes the average person significantly longer to set up alternatives such as bspwm, yabai, i3, hyprland etc.

Lastly, please add a field in the schema docs for whether it requires a restart, vs just saving the file.

Luckily all of the docs are generated from /// rustdoc comments so you can open a PR adding (restart required) wherever you notice this:

komorebi/komorebi/src/static_config.rs

Line 234 in 95fdb64

pub struct StaticConfig {

I'll summarize by comparing the schema docs to javadocs and the notion of pointing end users to javadocs.

I'm open to looking into other documentation generators, but the last time I looked this one had the most user-friendly output: https://github.com/coveooss/json-schema-for-humans

If you can put together a list of alternatives here with example outputs generated from schema.json in the project root that would be very helpful to compare the pros and cons of different generator outputs.

us Linux/Mac folks

This is actually me and I am by no means a Win32 dev :) For things like this where you feel like you could add more clarification based on your first-time user experience, you can also update the /// comments which get pulled into the documentation:

komorebi/komorebi/src/core/rect.rs

Line 7 in 95fdb64

pub struct Rect {

[bedge]

I just crossed over the hump, I think, after finding this post re: workspaces #1025
That was key.
I was thinking that the komorebi workspaces == windows virt desktops
If you work on that assumption it'll make your head explode as the terminology and model all match. There's nothing to say that these are not the same thing.
... other than the implicit fact that windows VD's span monitors, so unless you are more insightful than I am, that doesn't click that it is a logical impossibility for it all to be true.
Anyway, thanks for the input. I'll take a stab at contributing some docs. I think a multi-monitor HOWTO would be a net "good thing".

[LGUG2Z]

This one is actually not too bad: https://json-schema.app/view/%23?url=https%3A%2F%2Fraw.githubusercontent.com%2FLGUG2Z%2Fkomorebi%2Frefs%2Fheads%2Fmaster%2Fschema.json