mirror of
https://github.com/nix-dot-dev/nix.dev.git
synced 2024-10-04 00:57:52 +03:00
update contributing instructions (#987)
* update contributing instructions running devmode with `--run` doesn't actually work, it doesn't pick up the changes
This commit is contained in:
parent
ccc6d2dbf4
commit
a792a25bb0
2
.gitignore
vendored
2
.gitignore
vendored
@ -4,4 +4,4 @@ extracted/
|
||||
requirements_frozen.txt
|
||||
result
|
||||
source/_ext/__pycache__/
|
||||
TODO.txt
|
||||
.netlify
|
||||
|
@ -8,6 +8,25 @@ We strongly encourage everyone interested to participate:
|
||||
|
||||
Please read our [contributor guide](https://nix.dev/contributing/documentation) for more details.
|
||||
|
||||
## Local preview
|
||||
|
||||
Enter the development environment with `nix-shell`, or [set up direnv](https://nix.dev/guides/recipes/direnv.html)` and run `direnv allow`, and then:
|
||||
|
||||
```shell-session
|
||||
[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](./_redirects):
|
||||
|
||||
```shell-session
|
||||
[nix-shell:nix.dev]$ nix-build -A build
|
||||
[nix-shell:nix.dev]$ netlify dev -d result
|
||||
```
|
||||
|
||||
## Updating reference manuals
|
||||
|
||||
With the current setup, the [Nix manual hosted on nix.dev](https://nix.dev/reference/nix-manual) does not get updated automatically with new releases.
|
||||
|
12
README.md
12
README.md
@ -10,15 +10,3 @@ Official documentation for getting things done with Nix.
|
||||
Content is written in MyST, a superset of CommonMark. For its syntax, see the [MyST docs](https://myst-parser.readthedocs.io/en/latest/syntax/typography.html#syntax-core).
|
||||
|
||||
For contents and style see [contribution guide](CONTRIBUTING.md).
|
||||
|
||||
## Local preview
|
||||
|
||||
Run `nix-shell --run devmode` and open a browser at <http://localhost:5500>.
|
||||
|
||||
As you make changes your browser should auto-reload within a few seconds.
|
||||
|
||||
To manually test [redirects](./_redirects):
|
||||
|
||||
```console
|
||||
nix-shell -p netlify-cli --run "cd result; netlify dev"
|
||||
```
|
||||
|
@ -121,6 +121,7 @@ in
|
||||
pkgs.niv
|
||||
pkgs.python310.pkgs.black
|
||||
pkgs.vale
|
||||
pkgs.netlify-cli
|
||||
];
|
||||
};
|
||||
}
|
||||
|
Loading…
Reference in New Issue
Block a user