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

[Documentation] Relationship between digga API and raw flake API/output #461

Open
DrPyser opened this issue May 3, 2022 · 0 comments
Open
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@DrPyser
Copy link

DrPyser commented May 3, 2022

To properly understand how to use Digga in the context of the general nix/os ecosystem and properly integrate with other non-digga tooling, it would be very helpful to provide in the documentation a description of how the Digga API(lib.mkFlake) relates to the standard flake output interface.
One who has just started to understand Nix Flakes should be able to build on that knowledge to understand and use digga, and not simply have to relearn another opaque API.

For example,

  • how does the nixos attribute relates to the nixosConfigurations flake output attribute
  • homeConfigurations, homeConfigurationsPortable relates to what home-manager might expect
  • packages, containers, ...

Thanks for this work!

@DrPyser DrPyser added the bug Something isn't working label May 3, 2022
@Pacman99 Pacman99 added the documentation Improvements or additions to documentation label May 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants