Skip to content

Commit 3eabaac

Browse files
committed
updated docs
1 parent e110f20 commit 3eabaac

File tree

4 files changed

+49
-25
lines changed

4 files changed

+49
-25
lines changed

website/src/pages/hackboard/Faq2.mdx

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,14 @@
22

33
Welcome to the FAQ of the keyboard section! This part is pretty emtpy for now - drop your questions in the slack and I'll answer them here
44

5-
**Can I use metal for my case?** \
6-
NO!!!
7-
85
**Can I use a generator like Ergogen?** \
96
You're free to use it to experiment with layouts and make design decisions, but the actual placement of the footprints and schematic has to be done manually by you.
107

118
**Can I get PCBA?** \
12-
NO!!!!
9+
NO!!!!
10+
11+
**Can I get a 4 layer PCB?** \
12+
NO!!!!
13+
14+
**Can I use metal for my case?** \
15+
NO!!!

website/src/pages/hackboard/Overview.mdx

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Welcome to the keyboard section of hackpad! This section isn't completely finished, but here's roughly how it'll work and what's different from the macropad portion:
44

55
## Eligibility
6-
First, you MUST make a working macropad. No exceptions.
6+
First, you must have an approved PR for a macropad. It's okay if it hasn't been delivered to you yet! Just make sure it's merged
77

88
## Deadline
99
Tentatively, the deadline is March 16th, but Feb 16th if you're only making a macropad. if you're making a full-sized keyboard. This may be extended, but it's unlikely
@@ -14,12 +14,23 @@ Currently, there is no official guide as I'm not done my example! Instead, i'll
1414
Afterwards, I'll make a writeup for you to base yours off of.
1515

1616
## Approved parts
17-
Instead of having a set list, the only requirements are:
18-
- you use an Orpheus Pico as the main microcontroller. It's our in-house, drop-in replacement for the Raspberry Pi Pico.
19-
- You use 3mm acrylic, 3D printed plastic, or both for the case.
17+
Instead of having a set list, there are no required parts! Instead, you'll have limits on each part of your grant:
2018

21-
That's it! You can use any other custom parts you'd like - you'll be given a grant to get it.
19+
- **PCB:** No limit! It just needs to fall under the requirements in the [FAQ](/faq)
20+
- **Switches:** You're limited to a max value of $0.50/switch, *including shipping*. This should give you a good amount of variety.
21+
- **Fasteners:** $15
22+
- **Keycaps:** $25 - won't get you a very good set, but should give you something manageable.
23+
- **Stabilizers:** $20 - go get those TX AP, Durock, etc stabs! Your board should feel good
24+
- **Any other parts:** pitch me first - this is for stuff like rubber gaskets, dampening foam, etc.
2225

2326

27+
For the **MCU**, you have 2 options:
28+
- up to 2 Orpheus Picos (for split keyboards), our in-house, drop-in replacement for the Raspberry Pi Pico.
29+
- up to $8 for any MCU you want, including parts off LCSC if you want to integrate it. No exceptions for splits.
30+
31+
You can source microcontrollers yourself if the grant doesn't cover it but you want to design around something else
32+
33+
For the case, you can either use 3D printed PLA plastic, 3mm acrylic, or both!
34+
2435

2536

website/src/pages/hackpad/Faq.mdx

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
- An unsoldered Seeed XIAO RP2040 with headers
77
- Any of the components requested from the [approved parts list](/parts)
88
- a $20 HCB grant. This will be used to cover **both** your **PCB** as well as any additional parts you may want! I/O expanders, random sensors, etc. It MUST be used for your hackpad. You will need to upload receipts
9+
- USB C cables and USB hubs are not allowed.
910

1011
**When is the deadline?** \
1112
February 16th, 2025. This is the deadline for the macropad. The deadline for the keyboard is March 16th, 2025.
@@ -32,9 +33,6 @@ Unfortunately not! Not to fear though - we'll send you a soldering iron, straigh
3233
**Can I use acrylic/cnc metal/etc for the case/plate?** \
3334
NO!!! Only 3D prints are supported for the macropad. Keyboards are allowed to use acrylic, but CNC metal is still banned.
3435

35-
**Where are the parts shipped from?** \
36-
Vermont, USA!
37-
3836
**Can I use parts outside of the approved list?** \
3937
Yup! Put it in your $20 grant
4038

@@ -44,12 +42,20 @@ We have red, black, and white keycaps at HQ. You can request what color specific
4442
**Can I use Choc switches?** \
4543
You can! We'll have V2's at HQ. note: please use 19.05x19.05mm spacing, or else the keycaps won't fit
4644

47-
**I have more questions!!!** \
48-
Join the #hackpad channel in the Hack Club slack!
45+
**What are the footprint name for through hole diodes?** \
46+
- Diodes are D_DO-35_SOD27_P7.62mm_Horizontal.
4947

50-
**What are the footprint name for diodes/resistors?**
48+
**When are parts shipping / where are they shipped from?** \
49+
Vermont, USA!
50+
51+
**When will they ship?** \
52+
It'll be shipped from HQ the week of March break!
5153

52-
Diodes are D_DO-35_SOD27_P7.62mm_Horizontal.
54+
**When will PRs be reviewed??** \
55+
Around the deadline!
5356

54-
Resistors are R_Axial_DIN0204_L3.6mm_D1.6mm_P7.62mm_Horizontal
57+
**When will grants be issued?** \
58+
When we're done reviewing PRs!
5559

60+
**I have more questions!!!** \
61+
Join the #hackpad channel in the Hack Club slack!

website/src/pages/hackpad/Submission.mdx

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Finally finished your hackpad? Nice job! Follow along and we're going to make su
88
- [Publishing the design](#publishing)
99

1010
<a name="structure"/>
11-
## Structuring your project
11+
## Structuring your project design files
1212
To make reviewing easier, we need to make sure that the source files of our project are formatted in a way that's complete & easy to navigate.
1313

1414
### 1) Make sure you have everything necessary:
@@ -17,7 +17,6 @@ Before we organize anything, make sure
1717
- A *complete* CAD model of the assembled case in .STEP, .STP or .3MF format
1818
- This should include the PCB (a blank rectangle is okay!) and all parts of the case
1919
- Original firmware for your macropad. QMK, KMK, ZMK, etc derivatives are valid
20-
- A complete BOM (Bill of Materials) with all the parts you would like in a separate markdown document!
2120

2221
Additionally, make sure you meet the following requirements:
2322
- Your design uses a through-hole Seeed XIAO RP2040 as the main MCU
@@ -31,17 +30,22 @@ Additionally, make sure you meet the following requirements:
3130
If you have all of that, it should be ready to go!
3231

3332
### 2) Organize your folders
34-
The above is a LOT of files! To make reviewing as easy as possible, your submission format should have 3 folders:
33+
The above is a LOT of files! To make organization easy, you should create a folder for each part of your macropad:
3534

36-
- PCB
37-
- firmware
38-
- CAD
35+
**CAD:**
36+
This should contain a single file containing your ENTIRE hackpad. This should be a .STEP, .STP, or .3MF file
3937

40-
Put each part of your design in their correspoding folders.
38+
**PCB:**
39+
This should contain your PCB Design files
40+
41+
**Firmware: **
42+
This should contain the source files for your firmware. main.py if you're using KMK, and then several files if you're using QMK
43+
44+
In total, you should have 3 folders in your project folder.
4145

4246
<a name="export"/>
4347
## Creating production files
44-
Nice job on organizing your files! Next, we need to create the manufacturing files that will actually be used to build your project.
48+
Nice job on organizing your design files! Next, we need to create the manufacturing files that will actually be used to build your project.
4549

4650
This is separate from the source files, which are usually a reference to check out & iterate on your design.
4751

0 commit comments

Comments
 (0)