Merge main to vercel_deploy (#14)

* Update part4-product-spec-learning-phase.md * updated readme * Update README.md * Update part4-product-spec-learning-phase.md Added Technical Design Doc Template for levels 2 & 3 teams, and updated descriptions for each. Changed the title to better fit the new templates. * Update part4-product-spec-learning-phase.md (#13) --------- Co-authored-by: Elijah Melton <[email protected]> Co-authored-by: Elijah Melton <[email protected]>
hcp-uw · Nov 5, 2024 · 3bcf24b · 3bcf24b
1 parent 80a77d7
commit 3bcf24b
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 
 This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
 
-Here's the website: https://hcp-uw.github.io/hcp-documentation/
+Here's the website: [https://hcp-uw.github.io/hcp-documentation/](https://docs.hcp-uw.com/)
 
 ### Installation
 
@@ -31,6 +31,8 @@ This command generates static content into the `build` directory and can be serv
 
 Our docs are deployed through [vercel](https://vercel.com/husky-coding-projects-projects/docs/deployments) automatically from the `vercel_deploy` branch. Just push changes to `main`, and then merge `main` into `vercel_deploy` to deploy the changes.
 
+```
+=======
 ```bash
 git checkout main
 git pull

diff --git a/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md b/docs/project-team/project-guidelines/part4-product-spec-learning-phase.md
@@ -2,7 +2,7 @@
 sidebar_position: 5
 ---
 
-# Part 4: Product Spec + Learning Phase
+# Part 4: Technical Design Doc/Product Spec + Learning Phase
 
 <span style={{color: "red"}}><u>NOTE</u>: These two sections of Part 4 are **especially important** because it dictates your team’s project design and determines whether you are capable of contributing code once your team starts developing. Specifically for the learning phase, if you want to code, you must ensure you learn enough about the language you plan on coding in before you dive into it. See Learning Phase for more info.</span>
 
@@ -14,9 +14,11 @@ This is an **extremely important phase of your project that should not be taken
 
 **We do NOT encourage beginning project development until the entire spec has been completed, presented, and approved.** This is in order to provide your team with useful feedback and to help your team identify any potential gaps in your research or design for your team to fill in.
 
+There are two different technical design docs/product spec templates we provide to you. Your team can discuss which spec would be ideal for your learning and preparation, but we recommend that level 1 teams use this **[Product Technical Spec Template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=110339665080062140802&rtpof=true&sd=true)**, and that levels 2/3 use this **[Technical Design Doc Template](https://docs.google.com/document/d/1E9T0GCSYztEdXjgMYKJ06Pnkg4aySOzkGxQaabr3UbY/edit?usp=sharing)**. The only difference between the two is that the Technical Design Doc goes into more detail within your tech stack (High-level architecture, Databases, Models, Endpoints, Status Codes, etc.), so it may help your team answer more of the technical questions before you implement your project. It may be helpful to choose between one or another depending on the underlying knowledge between your teammates. Ask your club lead guide if you need guidance in choosing, or need example specs to read!
+
 Here’s the **[Google Docs template](https://docs.google.com/document/d/1q9trXkLShXKabYpFxLDtPcdL_WYOwwfW/edit?usp=sharing&ouid=104753064155446271905&rtpof=true&sd=true)** to get started. You can also navigate to `Resources/Project Spec Template` on this documentation website to find the spec template. This document highlights the requirements you need to meet with your technical spec and also has a template guide to follow. Please reference it closely and ask club leadership if you have any questions.
 
-Refer to your designated club lead guide for example specs to read. When you finish a rough draft of your spec, feel free to ask your club lead guide to give it a read-through and provide some feedback! We’re always happy to help and provide support to our project teams. **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get feedback on! Go to **Part 5** to see how this will work.
+When you finish a rough draft of your spec, let your club lead guide know so club leadership (our Design and Tech Teamns) can provide feedback! **Once your team is done with your spec**, there will be a spec presentation day where your team will present your spec and get additional feedback from project teams! Go to **Part 5** to see how this will work.
 
 ---