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

Use/write an interface definition language for docs and codegen #9817

Open
roberth opened this issue Jan 20, 2024 · 0 comments
Open

Use/write an interface definition language for docs and codegen #9817

roberth opened this issue Jan 20, 2024 · 0 comments
Labels
contributor-experience Developer experience for Nix contributors documentation feature Feature request or proposal

Comments

@roberth
Copy link
Member

roberth commented Jan 20, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contributor-experience Developer experience for Nix contributors documentation feature Feature request or proposal
Projects
None yet
Development

No branches or pull requests

1 participant