Skip to content
This repository has been archived by the owner on Jun 12, 2024. It is now read-only.

Add high level docs for the module system? #2

Open
matklad opened this issue Jun 9, 2024 · 0 comments
Open

Add high level docs for the module system? #2

matklad opened this issue Jun 9, 2024 · 0 comments

Comments

@matklad
Copy link
Contributor

matklad commented Jun 9, 2024

I’ve been trying to casually read the source code for the past few days, and, while in the small it is exceptionally readable (type signatures are :heart), I must confess that the larger picture eludes me.

That is, we define things which are to be “run” later by something else, but so far I’ve been missing that “main”.

I think what I am missing is the module system. Specifically, the module.run function. I looked at it, and reverse engineering its behavior is beyond my (admittedly limited) understanding of nix/NixOS.

I feel like this might be a stumbling block for many contributors, so documenting, in prose, how modules work, seems to be high impact!

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant