2023-06-12 Documentation team meeting notes #54


Today’s meeting was tightly-scoped; we focused on updating the Architecture section of the Nix Manual, in particular by adding a section on file system objects.


  • @Ericson2314: We should describe the data model of the objects in the store before describing the structure of the store itself.
  • @fricklerhandwerk: Reorganizing graphical representations:
    • Structure of data definition for filesystem objects. Using a Haskell-like syntax. Deleted this in favor of tree diagrams.
    • Restructuring the tree diagram representations of filesystem objects to replace the root string with a dot.
    • Should task @roberth with setting up graphviz to render nicer diagrams.
  • @proofconstruction: Question about the build infrastructure for manuals, mdbook, @pennae’s changes with the home-grown Python tooling. Manuals use markdown with several extensions.
  • Discussion:
    • Determining description of file system objects; Nix data model for representing file system data
    • What kinds of file system objects exist, vs. kinds of store objects
    • Store objects as special file system objects with references, sources from outside the nix store, derivations, and derivation outputs.
1 Like