From 1081a39ba3395726679caec4f9aef6b85c10247f Mon Sep 17 00:00:00 2001 From: Taran Mittal Date: Mon, 6 Oct 2025 08:49:42 +1100 Subject: [PATCH 1/5] Update Overview.mdx --- website/src/pages/hackboard/Overview.mdx | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index 6fa4a0a3..7251ab04 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -5,6 +5,28 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish ## Eligibility 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 +## YOUR PROJECT IS ACTUALLY COMPLETE: +-[x]It has a complete CAD assembly, with all components (including electronics) +-[x]You have firmware present, even if it's untested +-[x]You have sanity checked your design with someone else +-[x](optional) you have a 3D render of your project! + +## YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES: +-[x]a BOM, in CSV format in the root directory, WITH LINKS +-[x]the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc) +-[x]A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) +-[x]ANY other files that are part of your project (firmware, libraries, references, etc) + +Your keeb must also be shipped\ +In short, shipping is process of **actually making your project sharable.** It's the most important part of your project, almost as important as the entire project itself +- Documenting what your project actually is: + - A quick story/motivation on how the project came to be + - A description of what the project does + - A quick brief on how it all fits together + - Some pictures of the design +- Making all files & resources easily accessible & organized +- Putting it on a platform that's easily shareable (i.e github) + ## Deadline 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 From 8eebfcb6c205db937c4aa67856e089a366bc5b87 Mon Sep 17 00:00:00 2001 From: Taran Mittal Date: Mon, 6 Oct 2025 08:50:00 +1100 Subject: [PATCH 2/5] Fix formatting of checklist items in Overview.mdx --- website/src/pages/hackboard/Overview.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index 7251ab04..dbb804d5 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -6,16 +6,16 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish 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 ## YOUR PROJECT IS ACTUALLY COMPLETE: --[x]It has a complete CAD assembly, with all components (including electronics) --[x]You have firmware present, even if it's untested --[x]You have sanity checked your design with someone else --[x](optional) you have a 3D render of your project! +-[x] It has a complete CAD assembly, with all components (including electronics) +-[x] You have firmware present, even if it's untested +-[x] You have sanity checked your design with someone else +-[x] (optional) you have a 3D render of your project! ## YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES: --[x]a BOM, in CSV format in the root directory, WITH LINKS --[x]the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc) --[x]A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) --[x]ANY other files that are part of your project (firmware, libraries, references, etc) +-[x] a BOM, in CSV format in the root directory, WITH LINKS +-[x] the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc) +-[x] A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) +-[x] ANY other files that are part of your project (firmware, libraries, references, etc) Your keeb must also be shipped\ In short, shipping is process of **actually making your project sharable.** It's the most important part of your project, almost as important as the entire project itself From b23155d54ad320ce32322e886455e01b00222ab0 Mon Sep 17 00:00:00 2001 From: Taran Mittal Date: Mon, 6 Oct 2025 08:51:31 +1100 Subject: [PATCH 3/5] Update Overview.mdx --- website/src/pages/hackboard/Overview.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index dbb804d5..906de9ee 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -6,7 +6,7 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish 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 ## YOUR PROJECT IS ACTUALLY COMPLETE: --[x] It has a complete CAD assembly, with all components (including electronics) + It has a complete CAD assembly, with all components (including electronics)
-[x] You have firmware present, even if it's untested -[x] You have sanity checked your design with someone else -[x] (optional) you have a 3D render of your project! From 87a4630c2765b80202b63890856608eec140be4e Mon Sep 17 00:00:00 2001 From: Taran Mittal Date: Mon, 6 Oct 2025 08:52:27 +1100 Subject: [PATCH 4/5] Update Overview.mdx --- website/src/pages/hackboard/Overview.mdx | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index 906de9ee..22c6a8ad 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -6,16 +6,16 @@ Welcome to the keyboard section of hackpad! This section isn't completely finish 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 ## YOUR PROJECT IS ACTUALLY COMPLETE: - It has a complete CAD assembly, with all components (including electronics)
--[x] You have firmware present, even if it's untested --[x] You have sanity checked your design with someone else --[x] (optional) you have a 3D render of your project! +- It has a complete CAD assembly, with all components (including electronics) +- You have firmware present, even if it's untested +- You have sanity checked your design with someone else +- (optional) you have a 3D render of your project! ## YOUR GITHUB REPOSITORY CONTAINS ALL OF YOUR PROJECT FILES: --[x] a BOM, in CSV format in the root directory, WITH LINKS --[x] the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc) --[x] A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) --[x] ANY other files that are part of your project (firmware, libraries, references, etc) +- a BOM, in CSV format in the root directory, WITH LINKS +- the source files for your PCB, if you have one (.kicad_pro, .kicad_sch, gerbers.zip, etc) +- A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) +- ANY other files that are part of your project (firmware, libraries, references, etc) Your keeb must also be shipped\ In short, shipping is process of **actually making your project sharable.** It's the most important part of your project, almost as important as the entire project itself From 1ee23d01f3d4101b647119d6ef4237223422e505 Mon Sep 17 00:00:00 2001 From: Taran Mittal Date: Mon, 6 Oct 2025 08:54:21 +1100 Subject: [PATCH 5/5] Enhance Overview with README and project visuals Added sections for README content and project pictures. --- website/src/pages/hackboard/Overview.mdx | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/website/src/pages/hackboard/Overview.mdx b/website/src/pages/hackboard/Overview.mdx index 22c6a8ad..25f21325 100644 --- a/website/src/pages/hackboard/Overview.mdx +++ b/website/src/pages/hackboard/Overview.mdx @@ -17,7 +17,16 @@ First, you must have an approved PR for a macropad. It's okay if it hasn't been - A .STEP file of your project's 3D CAD model (and ideally the source design file format as well - .f3d, .FCStd, etc) - ANY other files that are part of your project (firmware, libraries, references, etc) -Your keeb must also be shipped\ +## YOUR README.md FILE CONTAINS THE FOLLOWING: +- A short description of what your project is +- A couple sentences on why you made the project + +### PICTURES OF YOUR PROJECT +- A screenshot of a full 3D model with your project +- A screenshot of your PCB +- A BOM in table format at the end of the README + +## Your keeb must also be shipped In short, shipping is process of **actually making your project sharable.** It's the most important part of your project, almost as important as the entire project itself - Documenting what your project actually is: - A quick story/motivation on how the project came to be