oeiuwq.com
Modular, context-aware and aspect-oriented dendritic Nix configurations.
Discussions: https://oeiuwq.zulipchat.com/join/nqp26cd4kngon6mo3ncgnuap/
den.oeiuwq.com
configurations
den
dendritic
nix
aspect
oriented
doc: expand on docs contribution instructions (#295)
+33
-5
+33
-5
docs/src/content/docs/contributing.md
+33
-5
docs/src/content/docs/contributing.md
···
33
33
34
34
### Contributing Documentation
35
35
36
-
If you have found some dead link or spelling/grammatical errors, please help by sending a PR.
36
+
The documentation website is under `./docs/`. Please help correct mistakes by sending a PR!
37
+
38
+
First, clone your fork of the repository.
37
39
38
-
The documentation website is under `./docs/`, You can run it locally with: `pnpm run dev`.
40
+
```
41
+
$ git clone 'https://github.com/<your-username>/den'
42
+
$ cd den
43
+
```
44
+
45
+
Next, enter a nix shell.
46
+
```
47
+
## Classic tooling
48
+
$ nix-shell -p just nodejs pnpm
49
+
## or flakes tooling!
50
+
$ nix shell 'nixpkgs#just nixpkgs#nodejs nixpkgs#pnpm'
51
+
```
52
+
53
+
Then, change to the docs directory and install the necessary dependencies to `docs/node_modules`.
54
+
55
+
```
56
+
$ cd docs
57
+
$ pnpm install
58
+
```
59
+
60
+
Finally, start the docs webserver.
61
+
62
+
```
63
+
$ just docs
64
+
```
65
+
66
+
Now, you can edit the `.mdx` files in `docs/src/content/docs` and see your changes reflected immediately.
39
67
40
68
41
69
### Helping other people
42
70
43
-
One of the best forms of contribution does not even involves PR. Hang out in our community
44
-
channels and help others getting aboard. Helping others is the best way to contribute.
71
+
One of the best forms of contribution does not even require submitting code. Hang out in our community
72
+
channels and help others with onboarding to den!
45
73
46
-
Thanks, You are awesome!
74
+
Thanks, You are awesome!
47
75