system-manager icon indicating copy to clipboard operation
system-manager copied to clipboard

doc: Add system-manager manual mdBook

Open eureka-cpu opened this issue 10 months ago • 3 comments

Adds a manual for system-manager akin to https://nix-community.github.io/home-manager/index.xhtml, built with mdBook.

eureka-cpu avatar Mar 01 '25 09:03 eureka-cpu

This still has a bit of a ways to go. I think I'd like to pause it after it gets close to finished to do #205 so that the documentation will feel more complete.

eureka-cpu avatar Mar 01 '25 09:03 eureka-cpu

Do you mind if we use mkDocs instead? We're using it on all our other projects. The best impl is on the treefmt project if you want to take a look.

zimbatm avatar Mar 04 '25 12:03 zimbatm

Do you mind if we use mkDocs instead? We're using it on all our other projects. The best impl is on the treefmt project if you want to take a look.

Ah sure, not a problem. I'll transition it to mkDoc once I get closer to finishing.

eureka-cpu avatar Mar 05 '25 07:03 eureka-cpu

Thanks for all the hard work you put into this PR. It already looks much better than what we had before. I think it could be merged as is, and then iterate on it. What do you think?

zimbatm avatar May 23 '25 20:05 zimbatm

Thanks for all the hard work you put into this PR. It already looks much better than what we had before. I think it could be merged as is, and then iterate on it. What do you think?

I'm away from my laptop where I'm running system-manager atm but I have some more changes I think I forgot to push. Would you mind waiting on those? I also still need to convert this to mkDoc.

Edit: I remember now, I was in the middle of adding a few examples including how to use timers and it adds links to documentation for SELinux and systemd nix usage.

eureka-cpu avatar May 23 '25 20:05 eureka-cpu

Ok, the only thing I didn't add was how to setup docker using system-manager. Maybe we can forward that and converting this to mkDocs to another PR?

eureka-cpu avatar May 24 '25 21:05 eureka-cpu

Thanks! We'll do the switch in another PR

zimbatm avatar May 26 '25 07:05 zimbatm