Creating a guide

[heitoke]

Please create a Wiki that will contain all functions, parameters, etc., and settings for this project, as well as examples of how it will look, because currently everything is written in the release. But it would be better if the release included a link to the Wiki so that one could read a more detailed description of a function or parameter, what it does, and an example of its use. I think other users would also contribute their own examples and their own settings of how they have customized driftwm to their liking.

[malbiruk]

Thanks for the suggestion! A couple of things worth clearing up:

Most of what you're describing already exists — it's just not in the releases (those are only changelogs):

• The README has videos of every major feature.
• config.reference.toml documents every option inline — what it does, its default, and example values. Copy it as your starting config.
• The docs/ folder has the deeper guides: window rules (docs/window-rules.md), shaders (docs/shaders.md), IPC (docs/ipc.md), gigapixel wallpapers (docs/gigapixel-wallpapers.md).

As for a full wiki — I think it's still a bit early for that. The config surface is small enough and reference config (in /etc/driftwm after installation) explains all values inline. README + docs/ are also not big and cover everything else. If driftwm grows so that there will be many big docs or reference config would become too big because of the comments, I'll revisit it.

For user-contributed examples — that part I love. I've opened a Gallery thread in Discussions for shaders and full setups #143

[heitoke]

As you said, the project is still small and there are few settings in the project, but in my opinion it's better to start running it now so as not to transfer a huge amount of information to the wiki later. Yes, there are examples in the README, but you won't always add to the README, it's easier and more logical to add separate pages and describe the information about this feature in more detail, since in my opinion it's better not to stretch the README too much.

[malbiruk]

You're right, the README should stay lean, and it will. The detailed stuff belongs on separate pages, which is what docs/ is for. The plan is to keep expanding those and eventually render them into a proper online docs site.

[heitoke]

I agree, it would be great to have a website with documentation.

[heitoke]

Honestly, I hope that there will be 2 views on the project's website, like a regular scroll version and like a canvas where you move, as in driftwm documentation. Perhaps I would help you implement this website, because I am a developer myself.

[malbiruk]

@heitoke
Yeah that would be a perfect contribution. The md files are all there, I also wired up auto-generated docs/config.md from config.reference.toml, so README.md and docs/ already cover the full content side. A web version would just add outline and search on top (something like mkdocs/Docusaurus).

If you'd like to take the lead on the site, I'd happily review PRs and help wire it into the repo / host it on GitHub Pages with CD on README/docs updates. The canvas view especially is your idea, so I'd love to see your take on it rather than impose mine.

[heitoke]

Yes, I don't mind, but unfortunately, I don't know when I'll be able to start developing the code, as I have a lot of work that takes up most of my time at the moment.