Skip to content

Commit cd2add8

Browse files
committed
Improved web contribution guide and index page. Also fixed some grammar
1 parent 3930197 commit cd2add8

3 files changed

Lines changed: 15 additions & 9 deletions

File tree

docs/contributing/website.mdx

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,13 @@
44

55
You can click the `Edit this page` button on any page to start editing it on GitHub or you can go to [ProjectNyxian/nyxian.app](https://github.com/ProjectNyxian/nyxian.app/tree/main/).
66

7-
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides)
7+
:::tip[General tip]
88

9-
### Writing Documentation
9+
You can find more documentation at [docusaurus.io](https://docusaurus.io/docs/category/guides).
10+
11+
:::
12+
13+
## Writing Documentation
1014

1115
All folders must contain an `index.mdx`. These and all `.mdx` files directly in [/docs](https://github.com/ProjectNyxian/nyxian.app/tree/main/docs/) should also contain a value for `sidebar_position` in the metadata.
1216

@@ -28,14 +32,17 @@ Please follow the best pratices from [markdownguide.org/basic-syntax](https://ww
2832

2933
:::tip
3034

31-
There is a [Todo](https://github.com/ProjectNyxian/nyxian.app#Todo) list in the README
35+
There is a [Todo](https://github.com/ProjectNyxian/nyxian.app#Todo) list in the README
3236

3337
:::
3438

35-
## Advanced
36-
You can also contribute to the website in various other ways and you can documentation for all other things on this at [docusaurus.io](https://docusaurus.io/docs).
39+
## React
40+
You can also contribute to the website in various other ways:
41+
- Improving [components](https://github.com/ProjectNyxian/nyxian.app/tree/main/src/components/)
42+
- Creating new components (your component must be used in atleast on page)
43+
- Helping on [pages](https://github.com/ProjectNyxian/nyxian.app/tree/main/src/pages/), like the index page
3744

38-
But please restraint from using swizzling to change the website. Always look if what you're trying to do can be achieved using classes and CSS.
45+
But please restraint from using swizzling to change the website (except if it's the offical way). Always look if what you're trying to do can be achieved using classes and CSS.
3946

4047
:::info
4148

docs/intro.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ sidebar_position: 0
44

55
# Introduction
66

7-
Nyxian is a iOS app that lets you build and deploy iOS apps directly on-device without owning any computer. Which means you can program wherever, whenever and in any type of situation. It currently supports iOS 16.0 upto the latest iOS version. It's designed for people that often find them selves on the go and don't want to take their mac with themselves and for the people who want to get into iOS software development, but don't own a mac. Previously such a app didn't exist, because no one tried to build something like this. Propably because people thought that it wasn't possible.
7+
Nyxian is a iOS app that lets you build and deploy iOS apps directly on-device without owning any computer. Which means you can program wherever, whenever and in any type of situation. It currently supports iOS 16.0 upto the latest iOS version. It's designed for people that often find themselves on the go and don't want to take their mac with themselves and for the people who want to get into iOS software development, but don't own a mac. Previously such a app didn't exist, because no one tried to build something like this. Propably because people thought that it wasn't possible.
88

99
:::info
1010

@@ -17,7 +17,7 @@ Remember Nyxian is still in beta, so some issue might arise! Please report issue
1717
- [x] Native iOS app development
1818
- [x] Native iOS utility development
1919
- [ ] Native iOS tweak development
20-
- [ ] Swift support
20+
- [ ] Swift support (soon...)
2121
- [x] Syscall Handling
2222
- [x] Sub processsing
2323

src/pages/index.module.css

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,5 @@
4040
}
4141

4242
.showcase {
43-
width: 75%;
4443
max-width: 50rem;
4544
}

0 commit comments

Comments
 (0)