Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tracking module system documentation #391001

Open
14 tasks
hsjobeki opened this issue Mar 18, 2025 · 0 comments
Open
14 tasks

Tracking module system documentation #391001

hsjobeki opened this issue Mar 18, 2025 · 0 comments
Labels
6.topic: documentation Meta-discussion about documentation and its workflow 6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals

Comments

@hsjobeki
Copy link
Contributor

hsjobeki commented Mar 18, 2025

This issue is intended to communicate remaining work specifically on the module system documentation.

This was mainly created out of #240531 and #390993 once merged this is some remaining work.

  • More code examples
  • Glossary that defines the often used terms (definitions module syntax ... )
  • Clarify the target audience of module system documentation
  • Place references between the tutorials, introduction and reference docs
  • Link used terminology references to the glossary
  • In code reference documentation for functions in:
    • modules.nix (i.e. evalModules )
    • options.nix (i.e. mkOption )
    • types.nix (i.e types.attrsOf )
  • in code reference documention for everything that is not a function such as:
    • option-types (i.e types.int )
    • options ( i.e. unknownModule )
    • other object "classes" (i.e. definitions, declarations, option-type )
    • split out definition modifiers (mkIf mkForce, ... ) into a seperate file and automatically link them.
@hsjobeki hsjobeki added 6.topic: documentation Meta-discussion about documentation and its workflow 6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals labels Mar 18, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
6.topic: documentation Meta-discussion about documentation and its workflow 6.topic: lib The Nixpkgs function library 6.topic: module system About "NixOS" module system internals
Projects
None yet
Development

No branches or pull requests

1 participant