updated docs

qcoral · qcoral · commit 73156bccfc20 · 2026-02-24T16:42:04.000-08:00
diff --git a/app/models/ai_review.rb b/app/models/ai_review.rb
@@ -1,3 +1,33 @@
+# == Schema Information
+#
+# Table name: ai_reviews
+#
+#  id                :bigint           not null, primary key
+#  analysis          :jsonb
+#  completed_at      :datetime
+#  completion_tokens :integer
+#  error_message     :text
+#  model_used        :string
+#  prompt_tokens     :integer
+#  raw_response      :text
+#  review_phase      :string           not null
+#  started_at        :datetime
+#  status            :string           default("queued"), not null
+#  total_tokens      :integer
+#  created_at        :datetime         not null
+#  updated_at        :datetime         not null
+#  project_id        :bigint           not null
+#
+# Indexes
+#
+#  index_ai_reviews_on_project_id                   (project_id)
+#  index_ai_reviews_on_project_id_and_review_phase  (project_id,review_phase)
+#  index_ai_reviews_on_status                       (status)
+#
+# Foreign Keys
+#
+#  fk_rails_...  (project_id => projects.id)
+#
 class AiReview < ApplicationRecord
   belongs_to :project
 
diff --git a/db/schema.rb b/db/schema.rb
diff --git a/docs/about/about-cost.md b/docs/about/about-cost.md
@@ -1,6 +1,7 @@
 | title       | About cost                            |
 | ----------- | ------------------------------------- |
 | description | A quick not about Hack Club and cost. |
+| priority    | 4                                     |
 
 
 # The Relationship Between Hack Club and Cost
diff --git a/docs/about/faq.md b/docs/about/faq.md
@@ -1,6 +1,7 @@
 | title       | FAQ                                        |
 | ----------- | ------------------------------------------ |
 | description | Frequently asked questions about Blueprint |
+| priority    | 5                                          |
 
 ##### FAQ
 
@@ -10,15 +11,20 @@
 
 Currently, the end-date of Blueprint is March 31st, 2026. You'll have time afterwards to spend your tickets.
 
-### What kind of projects can I make?
+## What are tickets? How do I earn them?
 
-You can make anything related to hardware where you put majority of the work in making the hardware side of the project. This includes things like keyboards, 3D printers and custom pcbs. Projects like home servers where you are mainly working on the software aspect are not allowed for Blueprint. If you are ever unsure of what your project may be considered as, ask in #blueprint on the Hack Club slack
+Tickets reward you for the effort spent on building the project.
+
+<span class="text-bp-warning">If you requested a grant, you get 8 to 10 tickets per hour of hands-on work after you get your grant, depending on the tier. This could be assembling, fixing CAD, etc.<br>If you didn't request a grant, you get 8 to 10 tickets per hour of all the hands-on time you spent on your project, depending on the tier! *You must actually build the project for this to count*</span>
+
+Your building time must be accurately logged in your journal. And we may adjust your ticket amount based on the quality of your final build.
 
-## How can I earn tickets?
+You can spend tickets in the [tool bag](/toolbag) to get tools and parts for your next project. The more tickets you have, the better stuff you can get.
 
-Project grants are awarded on quality rather than hours spent. However, if you track your time building your project after getting your grant (or all the time if you don't need a grant), you will be awarded with tickets which can be redeemed at the [toolbag](/toolbag). If your project doesn't have a lot of in-person build time, you will have fewer tickets awarded. One way to get more tickets for example is to get PCB + Components and hand-solder rather than just getting PCBA.
 
-Tickets are rewarded based on the effort you spent BUILDING your project, not the time spent DESIGNING it!
+## What kind of projects can I make?
+
+You can make anything related to hardware where you put majority of the work in making the hardware side of the project. This includes things like keyboards, 3D printers and custom pcbs. Projects like home servers where you are mainly working on the software aspect are not allowed for Blueprint. If you are ever unsure of what your project may be considered as, ask in #blueprint on the Hack Club slack
 
 
 ## How long may reviews take?
diff --git a/docs/about/index.md b/docs/about/index.md
@@ -1,72 +1,50 @@
 | title       | Overview                           |
 | ----------- | ---------------------------------- |
 | description | Explanation on how Blueprint works |
+| priority    | 1                                  |
 
-# Welcome to Blueprint
+# Welcome to Blueprint!
 
-We're a program by [Hack Club](https://hackclub.com?utm_source=blueprint) open to all teenagers 13-18 where you learn and build cool hardware projects and get funding to make them real!
+This is a [Hack Club](https://hackclub.com?utm_source=blueprint) program where you - yes *you*, can design any hardware project you want and get a grant to make it real!
 
-## Here's the quick rundown
+Open to all teenagers under 19 years old. 
 
-1. Design a [starter project](/starter-projects) or your own custom project.
-2. While you're working, log your progress on a journal on Blueprint.
-3. Apply for a grant up to $400 to buy the parts you need
-4. Build your project and journal your build time
-5. Earn tickets based on your build time
-6. Redeem tickets for tools and prizes in the [tool bag](/toolbag)!
+## Here's how it works:
 
-<!-- _Not all projects need a grant. You can earn extra tickets for the time spent if you do not request a grant._ -->
-
-Here's a more detailed look at how it all works:
-
-![blueprint how to](/old-cdn/309b8b95c9b370c89f44dc346212a72c120c4e7e_how-to.svg)
-
-## What can I build?
-
-<span class="text-bp-warning">You can make anything where you make custom hardware. This includes things like keyboards, 3D printers, or your very own custom PCBs!</span>
+#### 1. Start a new project!
 
-If this is your first time, you should check out the [starter projects](/starter-projects) we've created to help you learn the skills.
+Head on over to the Blueprint Dashboard and create a new project by clicking the section below:
 
-If you know what you want to build, make a custom project! From 3D printing to full robots with PCBs, you can create new designs or build off of existing creations. Work in groups if you want (but only one person should submit). We really want to see what you can cook up!
+![start a project](https://cdn.hackclub.com/019c784d-f810-79c7-a449-c4cac8a7aa9d/image.png)
 
-Make sure you have a project created on Blueprint before you start building so you can log your progress in the built-in journal. See the [submission guidelines](/about/submission-guidelines) for more details on what we expect from your project.
+Fill in all the details - you can always edit this later! Now it's time to start designing.
 
-If you need inspiration, check out what other folks are building on our [explore page](/explore)!
+**Make sure you read over the [project guidelines](/about/project-guidelines)** to get an idea of what you can make!
 
-## How much money can I get?
+#### 2. Journal your progress!
 
-<span class="text-bp-warning">You can apply up to $400 per project.</span> The amount you can get depends on the complexity of your project and how much effort you put into it. If you're building off of an existing creation, we only count the parts you added and modified.
+Every time you work on your design, make a journal entry in your dashboard! 
 
-You want to keep your projects original and your journal highly detailed. Don't be afraid to write everything down. It's good practice for engineering, and you'll get to share what you learned with the community!
+Journal entries are how you track your time & progress in Blueprint. They usually contain what you did during that work session, some interesting things you noticed, and a few images!
 
-To help you gauge how much funding you can get, we've created a tier system:
+**A great example journal entry can be found [here!](https://hwdocs.hackclub.dev/shipping/example-journal/)**
 
-![blueprint tiers](/old-cdn/25de1405658d50e80662edb588cd0ca0887c019f_Untitled-2025-10-22-1113-2.svg)
+#### 3. Submit your project, get a grant!
 
-<span class="text-bp-warning">The hour amounts are not hard requirements, they are just estimates of time needed for the average hacker to achieve the quality required.</span>
+Once you think you're done your project, make sure to go over each item in the **[submission requirements!](/about/submission-guidelines)** It'll ensure that your project is shipped. Your project will automatically be returned if it does not follow the requirements
 
-<span class="text-bp-warning">A tier's maximum cost is not a goal, you want to [reduce cost](/about/about-cost) as much as possible!</span>
+**Taking the extra few minutes to go through the checklist makes the review process faster for you and everyone else, since it means that we return projects less often.**
 
-## What are tickets? How do I earn them?
+#### 4. Build your project, get tickets!
 
-Tickets reward you for the effort spent on building the project.
+Order your parts and actually build your project! Make sure you keep
 
-<span class="text-bp-warning">If you requested a grant, you get 8 to 10 tickets per hour of hands-on work after you get your grant, depending on the tier. This could be assembling, fixing CAD, etc.<br>If you didn't request a grant, you get 8 to 10 tickets per hour of all the hands-on time you spent on your project, depending on the tier! *You must actually build the project for this to count*</span>
+At the end, post a demo on reddit or YouTube! You'll get **tickets** for your build which you can spend in the [tool bag](/toolbag)!
 
-Your building time must be accurately logged in your journal. And we may adjust your ticket amount based on the quality of your final build.
 
-You can spend tickets in the [tool bag](/toolbag) to get tools and parts for your next project. The more tickets you have, the better stuff you can get.
-
-## How do I get started?
-
-We've made it super easy to get started, it takes less than 5 minutes to start journaling.
-
-1. If you haven't already, [create an account](/auth/login) on Blueprint!
-2. Follow the tasks listed on your [home page](/) to set up your account and get started!
-3. If you're new to hardware, check out our [starter projects](/starter-projects) to learn the basics.
-4. Check the [faq](/faq) if you have any questions.
-5. Ask for help in [#blueprint-support](https://hackclub.slack.com/archives/C09CMJV6V6K) on the Hack Club Slack or email blueprint@hackclub.com if you have more questions!
+<!-- _Not all projects need a grant. You can earn extra tickets for the time spent if you do not request a grant._ -->
+*here's a diagram, if you need it!*
 
----
+![blueprint how to](/old-cdn/309b8b95c9b370c89f44dc346212a72c120c4e7e_how-to.svg)
 
-We're excited to see what you build!
+---
diff --git a/docs/about/project-guidelines.md b/docs/about/project-guidelines.md
@@ -0,0 +1,74 @@
+| title       | Project Guidelines                           |
+| ----------- | ---------------------------------- |
+| description | A guide to Hack Club Prototype |
+| unlisted    | false                                        |
+| priority    | 2                                            |
+
+# Project Guidelines!
+
+If you're wondering what you're allowed to build, here's a quick guide on what we generally look for! Please keep in mind these are just guidelines, so always feel free to ask in #blueprint!
+
+*above all though, the bottom line is this: build something awesome, something that you would be proud to keep in your room for the next 5 years, and something that you would be proud to show other people*
+
+---
+
+## Overview
+
+Here's an overall list of criteria that applies to all tiers, regardless of your budget/points.
+
+### Originality & idea
+
+Almost every idea out there has been thought of before - what matters is that when designing it, which means that you do *not* do the following:
+
+- Directly copy paste schematics
+- Directly copy paste layouts
+- Directly copy paste entire programs
+- Directly copy paste 3D printed / manufactured models (reference parts are OK)
+- **In general, do not copy paste stuff directly - use them as references**
+
+Generally speaking, each project must be closer to a product than a demo - that doesn't mean go ultra advertising mode, but that does mean that a breadboarded together project with no case *doesn't* count.
+
+Making multiple very-similar projects will also result in a decrease of ponits or a rejection (if they are too simillar).
+
+(more to be added)
+
+---
+
+## Tiers!
+![blueprint tiers](/old-cdn/25de1405658d50e80662edb588cd0ca0887c019f_Untitled-2025-10-22-1113-2.svg)
+
+Blueprint has **5** different tiers! Here's a quick diagram on what each one of them are, what you get, and some example projects of each.git 
+
+---
+
+
+## Examples
+**Here are some examples of great projects by Hack Clubbers:**
+
+- @Ducc's <a href="https://github.com/Dongathan-Jong/SpotifyDisplay/" target="_blank">Spotify Display</a>, a Spotify Car Thing Clone
+- @Cyao's <a href="https://github.com/cheyao/icepi-zero" target="_blank">Icepi Zero</a>, an FPGA development dev board
+- @vk6's <a href="https://github.com/ading2210/ender-x4" target="_blank">Ender X4</a>, a 4-toolhead 3D printer
+
+**Here are some examples of what *not* to build:**
+
+- Arduino alarm clock
+- Humidity display
+- Distance sensor
+
+**Here's some examples of how you could make those projects better:**
+
+- Arduino alarm clock, but it has custom LED lighting that syncs with the time of day & also has a slide switch instead of a button to control it
+- A humidity display that's part of a larger weather station setup and compares the internal readings of your house to the outside world 
+- A distance sensor that checks if someone is coming to your room & sends an alert to your phone if they do
+
+**Shipping your project is the process of making it usable & understanding for other people.** It means that someone should be able to look at your README.md file and know *exactly* what they need to do to build & use your project from scratch.
+
+This is really important! It makes sure that your project is actually real and exists in the world, and not just as a file on your computer.
+
+*A good read on this can be found here: [what is shipping?](/resources/shipping)*
+
+
+<!-- If you need inspiration, check out what other folks are building on our [explore page](/explore)! -->
+
+
+
diff --git a/docs/about/submission-guidelines.md b/docs/about/submission-guidelines.md
@@ -1,24 +1,16 @@
-| title       | Submission guidelines                              |
+| title       | Submit your project                         |
 | ----------- | -------------------------------------------------- |
 | description | Guidelines for submitting your project to the site |
-| priority    | 1                                                  |
+| priority    | 3                                                  |
 
-# Submission guidelines! 
+# Submission requirements!
 
-Here's everything you need to know to get your project approved!
+Here's everything you need to know to get your project approved! **Before going through this checklist, you should've read the [project guidelines](/about/project-guidelines)**
 
-The goal of Blueprint is to get you, yes *you* creating **shipped** projects. It is the *only* thing we check for - we try not to have any unnecessary / arbitrary requirements.
-
-**Shipping your project is the process of making it usable & understanding for other people.** It means that someone should be able to look at your README.md file and know *exactly* what they need to do to build & use your project from scratch.
-
-This is really important! It makes sure that your project is actually real and exists in the world, and not just as a file on your computer.
-
-*A good read on this can be found here: [what is shipping?](/resources/shipping)*
+The goal of Blueprint is to get you creating **shipped** projects. It is the *only* thing we check for - we try not to have any unnecessary / arbitrary requirements.
 
 **The following is a list of hard requirements from us, missing any of these will automatically get your project returned**
 
-Keep in mind that these are a *minimum*, and you're encouraged to go above and beyond! Add a 3D render, custom logo, and more - you might just get something special :)
-
 *any questions? ask in [#blueprint!](https://hackclub.enterprise.slack.com/archives/C083S537USC)*
 
 ---
