System-End/hackpad
1
0
Fork 0
mirror of https://github.com/System-End/hackpad.git synced 2026-04-19 22:15:14 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Change page organisation

Browse source
This commit is contained in:
cheyao 2025-02-11 23:06:58 +01:00
parent 39a1b657ef
commit 2dccc4c6e2
No known key found for this signature in database
2 changed files with 21 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

BIN
website/public/docs/v2/tree.png Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 118 KiB

38
website/src/pages/hackpad/Submission.mdx
View file

@ -155,9 +155,29 @@ PS. You might want to license your work, look at [https://choosealicense.com/](h
If you want, you can also add some readme files into your subdirectories, that would be awesome!
### Make a PR
First, double check your submission against the [Orpheuspad](https://github.com/hackclub/hackpad/tree/main/hackpads/orpheuspad) example to make sure you have the correct structure. Everything should match exactly, except for the filenames.
The directory should almost look like this:
<img src="/docs/v2/tree.png" className="max-w-96" />
If anything is unclear, make sure to ask in #hackpad!
Once everything is organized, you can make a PR to the repository [here](https://github.com/hackclub/hackpad)!
### After submitting
If everything went correctly, your PR will be reviewed (and hopefully approved!) by @alexren. If it's approved, then you'll get:
- All of your parts from the approved list
- A soldering iron
- A $20 grant for your PCB + custom components
- Your 3D printed case
For many of you, the firmware may not work the first try. That's okay! Keep working at it until it's fixed; if you send a video in #hackpad showing it working, I'll ship you a free custom hack-club keycap and sticker!
<a name="publishing"/>
## Publishing your project
The final step to making your PR is to actually publish your project! This involves writing a simple page for it explaining what it is.
You received your board, and now want the custom keycaps? You now need to actually publish your project! This involves writing a simple page for it explaining what it is.
First, go to the directory `website/src/pages/submissions`, create a new folder for your submission (Cyaopad for me). Then make a .mdx file that is named after your macropad (Cyaopad.mdx for me).
@ -184,19 +204,3 @@ Be sure to change the name to your own again. Now you should be able to view you
Your final result should look like this [this](/projects/cyaopad)
### Make a PR
First, double check your submission against the [Orpheuspad](https://github.com/hackclub/hackpad/tree/main/hackpads/orpheuspad) example to make sure you have the correct structure. Everything should match exactly, except for the filenames.
If anything is unclear, make sure to ask in #hackpad!
Once everything is organized, you can make a PR to the repository [here](https://github.com/hackclub/hackpad)!
### After submitting
If everything went correctly, your PR will be reviewed (and hopefully approved!) by @alexren. If it's approved, then you'll get:
- All of your parts from the approved list
- A soldering iron
- A $20 grant for your PCB + custom components
- Your 3D printed case
For many of you, the firmware may not work the first try. That's okay! Keep working at it until it's fixed; if you send a video in #hackpad showing it working, I'll ship you a free custom hack-club keycap and sticker!