- Past meeting notes
- Attendees: @infinisil @danielsidhion @hsjobeki @klinger @wamirez
- Notes by: @infinisil
Notes
- Merged doc: write improved documentation for nixosOptionsDoc by hsjobeki · Pull Request #295279 · NixOS/nixpkgs · GitHub
- Reviewed and merged doc: fix code to generate links for headings in the manual by DanielSidhion · Pull Request #297687 · NixOS/nixpkgs · GitHub
- Also merged backport of the original style improvement and this one
- nixos options now have
_module.argsappear in documentation.
@infinisil: It might make sense, but should maybe be moved to the bottom/end of the manual. -
init: frontmatter support by hsjobeki · Pull Request #114 · nix-community/nixdoc · GitHub
- Frontmatter syntax will likely be necessary for metadata anyways
- Makes documentation more separated from the implementation, but can be useful for longer documents
- A bit odd how once you have
importin the frontmatter, you can’t have content afterwards - Partly motivated by the trivial builders docs, which was mainly done to avoid duplication
- @infinisil’s preference would be to move the docs next to the source in that case, makes it easier to edit
- Leads to wanting displaying both source of documentation and source of implementation in the rendered output
- There might be some cases where argument declarations are really long, would be good to move it to a separate file there
- Maybe an alternative name?
- see_file
- defer_docs_to
- doc_location
- input/include
- Prefix with something to avoid clashes with other frameworks?
- Seems fine without, it can always be processed to take care of that if necessary
- Posted review