updated docs.. you can get your keycap now

This commit is contained in:
Alex Ren 2025-01-14 23:48:43 -05:00
parent c7667f9a64
commit b3680575ba
4 changed files with 49 additions and 9 deletions

View file

@ -8,13 +8,17 @@ import ApprovedParts from "./pages/ApprovedParts.mdx";
import Faq from "./pages/Faq.mdx";
import Braindump from "./pages/Braindump.mdx"
import Resources from "./pages/Resources.mdx"
import OrpheusPad from "./pages/OrpheusPad.mdx"
import ResearchNote from "./pages/ResearchNote.mdx"
import GetKeycap from "./pages/GetKeycap.mdx"
import DocPage from "./layouts/DocPage.tsx";
import { createBrowserRouter, RouterProvider } from "react-router-dom";
import "./index.css";
// IMPORT YOUR PROJECTS HERE
import OrpheusPad from "./pages/submissions/OrpheusPad.mdx"
const router = createBrowserRouter([
{
path: "/",
@ -51,7 +55,13 @@ const router = createBrowserRouter([
element: <DocPage Content={ ResearchNote } />,
},
{
path: "/projects/demopage",
path: "/get-keycaps",
element: <DocPage Content={ GetKeycap } />,
},
// Submitting? Great! Do something like this:
{
path: "/projects/orpheuspad",
element: <DocPage Content={ OrpheusPad } />
}
]);

View file

@ -0,0 +1,37 @@
# Get your Hack Club keycaps!
Finally got your hackpad, eager to get your new custom hc keycap? Read on to find out how!
## Assemble your hackpad
Once you got the hardware, you'll need to assemble it! Your XIAO RP2040 should've come presoldered, but you'll need to do the rest. You should've gotten a soldering iron sent to you as well (haven't yet? DM me in slack!).
If you don't know how to solder, [this](https://www.youtube.com/watch?v=QKbJxytERvg) video by Colin from Adafruit provides a great primer on soldering. Definitely would recommend you watch
As always, if you ever need help, ask in #hackpad!
## Get the firmware working
Once that works, send a video in #hackpad! Let the world see.
## Write your page!
Now you have an awesome working macropad, that you designed yourself. Time to write it!
Make sure to add each section! It really goes a long way to document your project. Imagine if I didn't docuemnt any of this
- Overview
- CAD model
- PCB
- Firmware
- BOM
- Any fun facts!!!
Check the [OrpheusPad](https://hackpad.hackclub.com/projects/orpheuspad) page as a reference
## Update the website to add your page
Here's your final part!
## Fill out the form!

View file

@ -88,5 +88,3 @@ If everything went correctly, your PR will be reviewed (and hopefully approved!)
- Your 3D printed/laser cut 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!
Reviewing will begin after the YSWS is over. Parts will be shipped 1-3 weeks after (depending on your parts stack).

View file

@ -4,16 +4,11 @@ Orpheuspad is a 4 key macropad with a rotary encoder, an OLED Display. It also h
I made it because hack club needed a tutorial macropad and there weren't any good options....
I'm 7 years old and from Mars!
## Fun facts
- This project took 20+ hours!!
- I redesigned it like 15 times...
- It glows underneath. Isn't that sick!!!
Here's my favourite meme:
![meme](https://pbs.twimg.com/media/GMW35z5WwAATFXs.jpg)
## What I learned