Documentation for the disko configuration format

[s-cerevisiae]

Currently for a user to learn and use disko, they have to look through various examples of different setups, since there's no central documentation of the format.
And for something as complex as filesystem setup, this is often not enough for users to infer where can each option be set, what they mean and how to customize them. A quick glance shows that tens of issues are directly related to the configuration being written wrong or misunderstood.

To improve user friendliness and reduce the effort of explaining the format, would you like to create a specification document for the configuration format?

[s-cerevisiae]

Just found that it is explained here: https://github.com/nix-community/disko/blob/master/docs/reference.md

[iFreilicht]

It would be nice if we could fix this issue. I'm wondering how option documentation is usually generated, I haven't looked into that yet.

[tim-elmer]

Should this issue be closed, given that this is an ongoing issue?

[iFreilicht]

@tim-elmer you're right. I actually merged a change recently that should enable us to work on this without hitting the recursion issue: #874