From 2ea34a3aa99d59d7727226c8b3a33470d99e7305 Mon Sep 17 00:00:00 2001 From: Alex Ren <41168529+qcoral@users.noreply.github.com> Date: Mon, 12 May 2025 22:52:23 -0400 Subject: [PATCH] fixed routing & sidebars, markdown is a little broken but ill get that done later --- app/helpers/docs_helper.rb | 0 app/views/advanced/_sidebar.html.erb | 11 ++-- app/views/advanced/communities.md | 17 +++++ app/views/advanced/design-guide.md | 11 ++++ .../advanced/misc-tips.md} | 0 app/views/advanced/overview.md | 48 ++++++++++++++ app/views/advanced/part-sourcing.md | 66 +++++++++++++++++++ ...ct_guidelines.md => project-guidelines.md} | 0 .../advanced/{submit.md => submitting.md} | 0 app/views/docs/api/overview.md | 0 app/views/docs/guides/index.md | 0 app/views/docs/guides/setup/index.md | 0 app/views/docs/show.html.erb | 0 app/views/layouts/docs.html.erb | 0 app/views/overview/_sidebar.html.erb | 6 +- app/views/overview/point-system.md | 19 ++++++ app/views/overview/points.md | 1 - app/views/overview/submit.md | 16 +++++ app/views/shared/_topbar.html.erb | 5 +- config/routes.rb | 5 +- 20 files changed, 192 insertions(+), 13 deletions(-) delete mode 100644 app/helpers/docs_helper.rb create mode 100644 app/views/advanced/communities.md create mode 100644 app/views/advanced/design-guide.md rename app/{controllers/docs_controller.rb => views/advanced/misc-tips.md} (100%) create mode 100644 app/views/advanced/overview.md create mode 100644 app/views/advanced/part-sourcing.md rename app/views/advanced/{project_guidelines.md => project-guidelines.md} (100%) rename app/views/advanced/{submit.md => submitting.md} (100%) delete mode 100644 app/views/docs/api/overview.md delete mode 100644 app/views/docs/guides/index.md delete mode 100644 app/views/docs/guides/setup/index.md delete mode 100644 app/views/docs/show.html.erb delete mode 100644 app/views/layouts/docs.html.erb create mode 100644 app/views/overview/point-system.md delete mode 100644 app/views/overview/points.md create mode 100644 app/views/overview/submit.md diff --git a/app/helpers/docs_helper.rb b/app/helpers/docs_helper.rb deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/advanced/_sidebar.html.erb b/app/views/advanced/_sidebar.html.erb index 446b6f7..e975d2a 100644 --- a/app/views/advanced/_sidebar.html.erb +++ b/app/views/advanced/_sidebar.html.erb @@ -2,10 +2,13 @@
<%# link_to "Projects", projects_path, class: "#{current_page?(projects_path) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "asdf", advanced_page_path("getting_started"), class: "#{current_page?(advanced_page_path("getting_started")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "Invite to Undercity", advanced_page_path("points"), class: "#{current_page?(advanced_page_path("points")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "Project guidelines", advanced_page_path("project_guidelines"), class: "#{current_page?(advanced_page_path("project_guidelines")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "How to submit", advanced_page_path("submit"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Overview", advanced_page_path("overview"), class: "#{current_page?(advanced_page_path("getting_started")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Project Guidelines", advanced_page_path("project-guidelines"), class: "#{current_page?(advanced_page_path("points")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Submitting", advanced_page_path("submitting"), class: "#{current_page?(advanced_page_path("project_guidelines")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Part Sourcing", advanced_page_path("part-sourcing"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Design Guide", advanced_page_path("design-guide"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Communities", advanced_page_path("communities"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Misc Tips", advanced_page_path("misc-tips"), class: "#{current_page?(advanced_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %>
diff --git a/app/views/advanced/communities.md b/app/views/advanced/communities.md new file mode 100644 index 0000000..806414a --- /dev/null +++ b/app/views/advanced/communities.md @@ -0,0 +1,17 @@ +--- +sidebar_position: 4 +--- + +---STALL--- + +# Other communities + +Hack Club is a *great* place, but the the truth is that we're really small too! + +### Discords +- VORON Discord +- QMK discord + +### Subreddits +- Keyboards +- Mechanical \ No newline at end of file diff --git a/app/views/advanced/design-guide.md b/app/views/advanced/design-guide.md new file mode 100644 index 0000000..2d655dc --- /dev/null +++ b/app/views/advanced/design-guide.md @@ -0,0 +1,11 @@ +# Designing your own project! + +1. Come up with an idea + +2. Sketch shit + +3. Research + +4. Design + +5. Build \ No newline at end of file diff --git a/app/controllers/docs_controller.rb b/app/views/advanced/misc-tips.md similarity index 100% rename from app/controllers/docs_controller.rb rename to app/views/advanced/misc-tips.md diff --git a/app/views/advanced/overview.md b/app/views/advanced/overview.md new file mode 100644 index 0000000..ef88ba8 --- /dev/null +++ b/app/views/advanced/overview.md @@ -0,0 +1,48 @@ +# Custom projects + +Have a project idea in mind already? Nice Job. + +## Here's how it works: + +### Overview + +1. Start your project +2. Journal & Log your progress along the way +3. Get $150 USD to build it. + +Each project you design that is approved gets you 6 points + +### Extra advanced projects + +If you have an idea + +### Allowed Vendors +By default, you're allowed to use + +### + +## Some tips + +## Starting your project + +In short, here's how to start a new project: + +1. Make a new GitHub repository +2. Create a file called JOURNAL.md and commit it +3. Make a pull request to add it to the repository +4. Start Designing your project! +5. Submit(insertlink) + +## Journaling + + + +### 3. Make a pull request to add it to the repository! +(insert instructions on how to make a PR to the yaml file) + +### 4. Get designing! + + +### 5. Submit! + +Once you're done, you can **submit** your project \ No newline at end of file diff --git a/app/views/advanced/part-sourcing.md b/app/views/advanced/part-sourcing.md new file mode 100644 index 0000000..ce8b4eb --- /dev/null +++ b/app/views/advanced/part-sourcing.md @@ -0,0 +1,66 @@ +--- +sidebar_position: 1 +--- +---STALL--- +# Sourcing parts + +Welcome to part sourcing! Here's a ton of tips for you to optimize the cost of your part + + + +If you're ever unsure of your BOM, send it in #highway! People can definitely help you pick bigger parts. + +## Specific parts + +### Modules (TP4056, LED matrices, etc) + +Almost always the cheapest option is to get it from AliExpress; the only downside is that shipping *may* take awhile + +If you're in a pinch, Amazon actually has OK prices all things considered. + +### SBCs (Raspberry Pi, Orange Pi, etc) +Raspberry Pi +You can get Orange Pis from aliexpress. + +Depending on your application though, you can also repurpose old laptops/desktops for your specific application if it's not space-sensitive + +### Microcontrollers (arduino, RP2040, etc) +AliExpress is still usually your go-to for this! + +Arduinos are fairly outdated by todays standards + +### PCBs + +- If you're in India, use SEEED. They take HCB cards and are by far the cheapest option +- If you're from another country, use JLCPCB, they offer pcbs for under $6 shipped as long as its under 100x100mm +- If you're from the US specifically, use PCBWAY. They're roughly half the cost of JLCPCB because they're able to avoid tarrifs some how + - Read here: [link](https://www.pcbway.com/blog/News/Impact_of_the_New_U_S_Tariff_Policy_on_Customs_Clearance_51dff4fd.html) + +### Batteries (Li-Po, CR2032, AA, etc) + +## Specific countries + +### India: +- Most vendors do not take int'l cards, which unfortunately HCB falls into the category of. Contact your local vendors to try to get that changed! + +> contribute here!! We're missing a ton of stuff + +## Tips for specific vendors + +### AliExpress +aliexpress is one of the highest skill ceiling stores out there - there's a ton of optimization you can do. Here's some tips: + +- The welcome deal only works once when you make your account, so don't budget off of that - you will be hit by significantly higehr prices afterwards. +- Pay attention to the estimate shipment date. This will vary by region, but generally speaking it's actually fairly reliable +- Also pay attention to the shipping cost! Usually items that don't have free shipping but a lower initial price actually end up being more expensive when you tally the costs +- There's specific vendors that are useful: + - AITXEM ROBOT + - Triangleab + +## Other resources + +### VORON Sourcing guide + +### ANNEX ENGINEERING Sourcing guide + +### ??? add here! \ No newline at end of file diff --git a/app/views/advanced/project_guidelines.md b/app/views/advanced/project-guidelines.md similarity index 100% rename from app/views/advanced/project_guidelines.md rename to app/views/advanced/project-guidelines.md diff --git a/app/views/advanced/submit.md b/app/views/advanced/submitting.md similarity index 100% rename from app/views/advanced/submit.md rename to app/views/advanced/submitting.md diff --git a/app/views/docs/api/overview.md b/app/views/docs/api/overview.md deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/docs/guides/index.md b/app/views/docs/guides/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/docs/guides/setup/index.md b/app/views/docs/guides/setup/index.md deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/docs/show.html.erb b/app/views/docs/show.html.erb deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/layouts/docs.html.erb b/app/views/layouts/docs.html.erb deleted file mode 100644 index e69de29..0000000 diff --git a/app/views/overview/_sidebar.html.erb b/app/views/overview/_sidebar.html.erb index aa915cf..890577e 100644 --- a/app/views/overview/_sidebar.html.erb +++ b/app/views/overview/_sidebar.html.erb @@ -2,10 +2,10 @@
<%# link_to "Projects", projects_path, class: "#{current_page?(projects_path) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "Getting started", overview_page_path("getting_started"), class: "#{current_page?(overview_page_path("getting_started")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "Invite to Undercity", overview_page_path("points"), class: "#{current_page?(overview_page_path("points")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> - <%= link_to "Project guidelines", overview_page_path("project_guidelines"), class: "#{current_page?(overview_page_path("project_guidelines")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Overview", overview_page_path("overview"), class: "#{current_page?(overview_page_path("overview")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "The Point System", overview_page_path("point-system"), class: "#{current_page?(overview_page_path("point-system")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> <%= link_to "How to submit", overview_page_path("submit"), class: "#{current_page?(overview_page_path("submit")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %> + <%= link_to "Undercity", overview_page_path("undercity"), class: "#{current_page?(overview_page_path("undercity")) ? 'bg-[#564CAD]' : 'hover:bg-[#564CAD]'} bg-[#2E2A54] p-2 rounded transition duration-100 block" %>
diff --git a/app/views/overview/point-system.md b/app/views/overview/point-system.md new file mode 100644 index 0000000..0fecc86 --- /dev/null +++ b/app/views/overview/point-system.md @@ -0,0 +1,19 @@ +# The point system + +Points are the currency of Highway! Here's everything you need to know about them. + +As always, if you have any questions, ask in #highway-help! + +--- + +## Overview + +Points are awarded when you either: +- Attend an event that gives you 1 point +- Get a design approved + - Starter projects: 4 points + - Custom projects: 6/10 points. + +By default, custom projects give you 6 points, but if its a particularly complicated project (i.e 3D printer), you can get 10 points out of it. + +To get 10 points, you MUST get confirmation on your idea BEFORE working on it first. DM @alexren on the slack to check with them first! \ No newline at end of file diff --git a/app/views/overview/points.md b/app/views/overview/points.md deleted file mode 100644 index 1141154..0000000 --- a/app/views/overview/points.md +++ /dev/null @@ -1 +0,0 @@ -insert point system on how to get into undercity \ No newline at end of file diff --git a/app/views/overview/submit.md b/app/views/overview/submit.md new file mode 100644 index 0000000..b183c79 --- /dev/null +++ b/app/views/overview/submit.md @@ -0,0 +1,16 @@ +# Submitting projects + +Submitting your project is SUPER easy! Once you have everything ready, **fill out the following form**: + +https://forms.hackclub.com/highway + +Please double check that you have everything necessary! This will depend on your project + +If your project is rejected for any reason, you will have to wait 1 week before it gets re-reviewed + + +# Collecting your points + +When you get approved, you'll get an email! Your points will automatically get added to the system + +To check your points, go to #highway and run /checkpoints! \ No newline at end of file diff --git a/app/views/shared/_topbar.html.erb b/app/views/shared/_topbar.html.erb index 50ced44..43da42d 100644 --- a/app/views/shared/_topbar.html.erb +++ b/app/views/shared/_topbar.html.erb @@ -24,10 +24,9 @@ diff --git a/config/routes.rb b/config/routes.rb index 859b812..b5d2981 100644 --- a/config/routes.rb +++ b/config/routes.rb @@ -53,10 +53,11 @@ Rails.application.routes.draw do get "/prize_box", to: "users#prize_box", as: :prize_box get "/launchpad", to: "launchpad#show" - get "/overview", to: redirect("/overview/getting_started") - get "/overview/:page", to: "overview#show", as: "overview_page" + get "/getting-started", to: redirect("/getting-started/overview") + get "/getting-started/:page", to: "overview#show", as: "overview_page" get "/advanced/:page", to: "advanced#show", as: "advanced_page" + get "/advanced/", to: redirect("/advanced/overview") get "/events", to: "events#index" end