Skip to content

Latest commit

 

History

History
48 lines (32 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

48 lines (32 loc) · 1.64 KB

Contributing to nix.dev

nix.dev is a community effort to collect, create, and maintain world-class learning resources for Nix.

We strongly encourage everyone interested to participate:

  • Make a pull request if you want to introduce an incremental change.
  • Open an issue if you want to discuss a significant change before starting to work on it.

Please read our contributor guide for more details.

Local preview

Enter the development environment with nix-shell, or set up direnv and run direnv allow, and then:

[nix-shell:nix.dev]$ devmode

and open a browser at http://localhost:5500.

As you make changes, your browser should auto-reload.

To manually test redirects:

[nix-shell:nix.dev]$ nix-build -A build
[nix-shell:nix.dev]$ netlify dev -d result

Building the reference manuals

By default nix.dev builds without the various versions of the Nix reference manual, as that takes quite a while due to how it's currently implemented. To enable building the manuals:

[nix-shell:nix.dev]$ nix-build -A build --arg withManuals true
[nix-shell:nix.dev]$ devmode --arg withManuals true

Updating reference manuals

With the current setup, the Nix manual hosted on nix.dev does not get updated automatically with new releases. The following manual steps are required:

nix-shell --run update-nixpkgs-releases
nix-shell --run update-nix-releases