snowfallorg / snowfallorg/lib

Documentation: `/homes/${system}/${user}` vs `/homes/${system}/${user}@${host}` capabilities

Open Beginner friendly
#159 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Nix
Stars
628
Forks
64
PR merge metrics
No merged PRs in 30d

Description

I have been curiously looking at https://github.com/jakehamilton/config to understand how snowfall can actually be used.

There I've noticed /homes/x86_64-linux/short/default.nix which isn't in the user@host format.

It turns out that if you have a machine host, and create:

  • /homes/x86_64-linux/user/default.nix
  • /homes/x86_64-linux/user@host/default.nix

Then both modules are imported when building user's home on host.

This is great and intuitive, I could adopt this in my configs (https://github.com/nicdumz/nix-config/pull/23/commits/dee7eaa7c2defc3736d2bcb409d188f211fabcf3) but https://snowfall.org/guides/lib/homes/ and https://snowfall.org/reference/lib/#flake-structure do not document this (great) feature.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the homes guide and the flake-structure reference linked in the issue, then compare their current descriptions with the documented /homes/${system}/${user} and /homes/${system}/${user}@${host} layouts. Done means both pages explain that the matching modules are imported when building a user's home on a host.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
65/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.