docs(manual): Initial draft of the user manual

[akirak]

No description provided.

[akirak]

I have added some contents, but documentation still has a lower priority.

[brsvh]

Is this PR work still going on?

[akirak]

Is this PR work still going on?

I'm thinking of discarding this PR. Now I generally don't like the idea of containing documentation in the repository as the source code, especially for Nix projects. That way, the user would have to update the flake input every time the documentation is updated, which is undesirable.

Instead, my plan is as follows:

• Create a separate repository for the user documentation, to which a broader audience can contribute. Hyprland Wiki is a source of inspiration.
• Containing only ADRs in the source repository.

[brsvh]

Your considerations sound quite reasonable.

I've recently been using Twist to manage my configurations and have recommended it to my friends. To some extent, I always get lost in the source code, which is quite annoying. I noticed that you already have a github.io site, perhaps you could consider setting up a documentation entry for Twist there.

[akirak]

To some extent, I always get lost in the source code, which is quite annoying.

@terlar currently maintains a working configuration built with twist, which you could use as a reference. Sorry for not putting an effort on the documentation side. If you have any question, please ask at Discussions.

I noticed that you already have a github.io site, perhaps you could consider setting up a documentation entry for Twist there.

I am still thinking about how to integrate documentation with the website. Some decisions would be involved.