Skip to content

Commit ee56e23

Browse files
authored
Reworked all contributing guides
1 parent a3c4715 commit ee56e23

3 files changed

Lines changed: 95 additions & 25 deletions

File tree

Nyxian/docs/contributing/Nyxian.mdx

Lines changed: 19 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
# Contributing to Nyxian
22

3+
Thank you soooo much for your interest in Nyxian and contributing to it, I had the idea to make this file to show that im very confused about why nobody has contributed to Nyxian yet.
4+
35
## Getting Started
46

57
### Prerequisites
6-
- A mac with Xcode and Theos
8+
- A mac with Xcode and Theos and the brew package dependencies(`pkgconf`, `cmake`, `libarchive`, `dpkg`)
79
- A iPhone/iPad with iOS 16+
810
- A free or paid apple developer account
911
- The certificate used to sign Nyxian (you can get that from keychain after installing Nyxian over Xcode).
@@ -14,7 +16,7 @@
1416
```bash
1517
git clone --recursive https://github.com/emexlab/Nyxian.git
1618
cd Nyxian
17-
make jailed
19+
make
1820
```
1921
2. Open it in Xcode (Now you can enjoyyy)
2022

@@ -100,7 +102,7 @@ TaskPortObject *get_tpo_for_pid(pid_t pid);
100102
```
101103
102104
### General
103-
- GPL v3 header on all new files
105+
- AGPL v3 header on all new files
104106
- Minimal comments - code should be self-documenting
105107
- Defensive programming - check validity before operations (otherwise I will never ever again accept a PR from you)
106108
- No force unwraps in Swift unless provably safe
@@ -109,22 +111,24 @@ TaskPortObject *get_tpo_for_pid(pid_t pid);
109111
All files must include:
110112
```
111113
/*
112-
Copyright (C) 2025 emexlab
114+
SPDX-License-Identifier: AGPL-3.0-or-later
115+
116+
Copyright (C) 2026 yourname
113117

114-
This file is part of Nyxian.
118+
This file is part of Nyxian.
115119

116-
Nyxian is free software: you can redistribute it and/or modify
117-
it under the terms of the GNU General Public License as published by
118-
the Free Software Foundation, either version 3 of the License, or
119-
(at your option) any later version.
120+
Nyxian is free software: you can redistribute it and/or modify
121+
it under the terms of the GNU Affero General Public License as published by
122+
the Free Software Foundation, either version 3 of the License, or
123+
(at your option) any later version.
120124

121-
Nyxian is distributed in the hope that it will be useful,
122-
but WITHOUT ANY WARRANTY; without even the implied warranty of
123-
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
124-
GNU General Public License for more details.
125+
Nyxian is distributed in the hope that it will be useful,
126+
but WITHOUT ANY WARRANTY; without even the implied warranty of
127+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
128+
GNU Affero General Public License for more details.
125129

126-
You should have received a copy of the GNU General Public License
127-
along with Nyxian. If not, see <https://www.gnu.org/licenses/>.
130+
You should have received a copy of the GNU Affero General Public License
131+
along with Nyxian. If not, see <https://www.gnu.org/licenses/>.
128132
*/
129133
```
130134
You have to add your name undernethe the names of other people that have contributed in-case youre not in that list already. If you're the original creator of a new file in Nyxian then your name is the first instead of mine, I add mine underneath yours in that case when I add or change something of your code!

Nyxian/docs/contributing/index.mdx

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@ sidebar_position: 4
44

55
# Contributing
66

7-
Thank you soooo much for your interest in Nyxian and contributing to it!
7+
Thank you for deciding to contribute to Nyxian!
8+
We are grateful for all contributors.
89

9-
You can contribute to:
10+
Even if you **can't code or don't have Xcode** you can still contribute to [this website and it's documentation](/website/contributing).
1011

11-
[Nyxian's code](Nyxian.mdx) or [this website](/website/contributing)
12+
If you know how to code in Xcode please help out on [Nyxian's code](Nyxian.mdx), help is greatly appreciated!

src/pages/website/contributing.mdx

Lines changed: 72 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,77 @@
11
# Contributing to this Website
22

3-
## Quickstart
3+
Select where you want to contribute below.
44

5-
You can click the `Edit this page` button at the bottom of any page to start editing it on GitHub or you can go to [emexlab/emexlab.github.io](https://github.com/emexlab/emexlab.github.io/tree/main/).
5+
<Tabs queryString="method">
6+
<TabItem value="github" label="Github" default>
7+
## Quickstart
68

7-
:::tip[general tip]
9+
You can click the `Edit this page` button at the bottom of any page to start editing it on GitHub or you can go to [emexlab/emexlab.github.io](https://github.com/emexlab/emexlab.github.io/tree/main/).
810

9-
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides).
11+
## Github Pages
12+
13+
You can find an automatic build of the newest state at https://emexlab.github.io/
14+
</TabItem>
15+
<TabItem value="local" label="Locally">
16+
## Quickstart
17+
18+
```bash
19+
./quickstart.sh
20+
```
21+
22+
This script setups everything for you.
23+
24+
## Installation
25+
26+
```bash
27+
npm install
28+
```
29+
30+
## Local Development
31+
32+
```bash
33+
npm run start
34+
```
35+
36+
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
37+
38+
## Build
39+
40+
```bash
41+
npm run build
42+
```
43+
44+
This command generates static content into the `build` directory and can be served using any static contents hosting service.
45+
46+
## Deployment
47+
48+
### Github Pages
49+
50+
You can find an automatic build of the newest state at https://emexlab.github.io/
51+
52+
### SSH
53+
54+
```bash
55+
./deploy.sh user@host
56+
```
57+
58+
This will build the site and upload it via ssh to the specified host as the specified user.
59+
60+
:::note
61+
62+
It's recommended to set up SSH keys beforehand. Otherwise, pass `-n` and expect several SSH password prompts during deployment.
63+
64+
:::
65+
</TabItem>
66+
</Tabs>
67+
68+
69+
:::tip
70+
71+
There is a [Todo](https://github.com/emexlab/emexlab.github.io#Todo) list in the README.
72+
This is a good starting point for first time contributors.
73+
74+
The README also explains how to get started.
1075

1176
:::
1277

@@ -15,7 +80,7 @@ You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/ca
1580
All files should be use `.mdx` instead of `.md`.
1681
All folders must contain an `index.mdx`. These and all `.mdx` files directly in a `/docs` folder should also contain a value for `sidebar_position` in the metadata.
1782

18-
``` mdx title="exampleDoc.mdx"
83+
```mdx title="exampleDoc.mdx"
1984
---
2085
sidebar_position: 2
2186
---
@@ -33,8 +98,8 @@ Please follow the best pratices from [markdownguide.org/basic-syntax](https://ww
3398

3499
:::tip
35100

36-
There is a [Todo](https://github.com/emexlab/emexlab.github.io#Todo) list in the README.
37-
This is a good starting point for first time contributors
101+
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides).
102+
The websites github is also a good reference point: [docusaurus/website](https://github.com/facebook/docusaurus/tree/main/website)
38103

39104
:::
40105

0 commit comments

Comments
 (0)