Use/write an interface definition language for docs and codegen #9817
Labels
contributor-experience
Developer experience for Nix contributors
documentation
feature
Feature request or proposal
Is your feature request related to a problem? Please describe.
We currently rely on a built Nix to provide the inputs for the manual. Rebuilds slow down documentation work, and make it far less accessible to contributors, as it requires a degree of familiarity with the tooling and/or unbearable iteration cycle times.
This architecture restricts the tooling we can use for documentation.
Describe the solution you'd like
Use an existing interface definition language that has good documentation support, or write a simple one based on JSON.
Describe alternatives you've considered
A build mode that only compiles a small set of files; just enough to pull out the docs.
Lean into Nix as a language processing tool. It makes for a nicer end user experience, and perhaps more coherent tooling (despite being somewhat custom). This may be more of an addition than an alternative actually.
Additional context
Priorities
Add 👍 to issues you find important.
The text was updated successfully, but these errors were encountered: