docs: 📚️ zotmeal-peterplate code quality (#44)

EightBitByte · web-flow · commit 06b9a3820279 · 2025-11-27T14:11:35.000-08:00
* chore(docs): 🔧 📚️ zotmeal -&gt; PeterPlate

* chore: 🔧 update codeowners and folder names

* revert: ⏪️ revert peterplate team name to zotmeal until changed

* docs: 📚️ add committing &amp; code quality

* docs: 📚️ update all links from zotmeal to peterplate
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -7,7 +7,7 @@ content/docs/contributor/developer @icssc/api
 
 content/docs/contributor/zotistics @icssc/zotistics
 
-content/docs/contributor/zotmeal @icssc/zotmeal
+content/docs/contributor/peterplate @icssc/peterplate
 
 content/docs/contributor/zotmeet @icssc/zotmeet
 
diff --git a/content/docs/contributor/index.mdx b/content/docs/contributor/index.mdx
@@ -46,8 +46,8 @@ import { Workflow, UtensilsCrossed, Bird, CalendarRange } from "lucide-react";
   </Card>
   <Card
     icon={<UtensilsCrossed />}
-    href="/docs/contributor/zotmeal"
-    title="ZotMeal"
+    href="/docs/contributor/peterplate"
+    title="PeterPlate"
   >
     Dining Hall Menus
   </Card>
diff --git a/content/docs/contributor/meta.json b/content/docs/contributor/meta.json
@@ -8,7 +8,7 @@
     "peterportal",
     "anteaterapi",
     "zotistics",
-    "zotmeal",
+    "peterplate",
     "zotnfound",
     "zotmeet"
   ],
diff --git a/content/docs/contributor/peterplate/api/index.mdx b/content/docs/contributor/peterplate/api/index.mdx
@@ -4,20 +4,20 @@ title: API
 
 import { ServerOff, Database } from "lucide-react";
 
-ZotMeal implements its very own API for use with the project. Information on
-how to extend the API and use it for ZotMeal can be found below.
+PeterPlate implements its very own API for use with the project. Information on
+how to extend the API and use it for PeterPlate can be found below.
 
 <Cards>
   <Card
     icon={<ServerOff/>}
-    href="/docs/contributor/zotmeal/api/serverless"
+    href="/docs/contributor/peterplate/api/serverless"
     title="Serverless"
   > 
     Cron jobs
   </Card>
   <Card
     icon={<Database/>}
-    href="/docs/contributor/zotmeal/api/trpc"
+    href="/docs/contributor/peterplate/api/trpc"
     title="tRPC"
   >
     Database tasks
diff --git a/content/docs/contributor/peterplate/api/meta.json b/content/docs/contributor/peterplate/api/meta.json
diff --git a/content/docs/contributor/peterplate/api/serverless.mdx b/content/docs/contributor/peterplate/api/serverless.mdx
@@ -4,7 +4,7 @@ title: Serverless Functions
 
 import { File, Folder, Files } from "fumadocs-ui/components/files";
 
-As opposed to managing a server backend, ZotMeal uses serverless functions that are ran on-demand in the cloud, with AWS Lambda as our cloud service.
+As opposed to managing a server backend, PeterPlate uses serverless functions that are ran on-demand in the cloud, with AWS Lambda as our cloud service.
 
 ## Cron Jobs
 
diff --git a/content/docs/contributor/peterplate/api/trpc.mdx b/content/docs/contributor/peterplate/api/trpc.mdx
@@ -113,7 +113,7 @@ We will now go into detail about each individual tRPC procedure.
 `getRestaurantsByDate`
 	Queries the database for information on both restaurants corresponding to a given date.
 - Input: `Date`
-- Returns: `ZotmealData`
+- Returns: `PeterPlateData`
 ## Stations
 
 #### Services
diff --git a/content/docs/contributor/peterplate/code-quality.mdx b/content/docs/contributor/peterplate/code-quality.mdx
@@ -0,0 +1,39 @@
+---
+title: Committing & Code Quality
+description: Keeping PeterPlate clean and maintainable for your team and the future.
+icon: Braces
+---
+
+PeterPlate follows the [code quality practices](/docs/contributor/common/code-quality) 
+established by the ICSSC projects board. To maintain a readable, maintainable, 
+and extensible codebase, we utilize specific technologies and standards.
+
+## Code Quality
+### Biome
+
+Like many other ICSSC projects, we use [Biome.js](https://biomejs.dev/) to 
+lint and format our code. We leverage [Husky](https://github.com/typicode/husky) 
+to automatically run Biome, which lints and formats your code before it is 
+committed and pushed.
+
+#### Rules
+
+Our Biome configuration can be found 
+[here](https://github.com/icssc/PeterPlate/blob/main/biome.json). Here's a quick 
+overview of our current rules, which are subject to change:
+
+- Indent by two spaces 
+- Line width is 80 characters
+- Double quote style
+- Always use semicolons
+- Organize imports
+
+If you would like to suggest a new rule, please reach out to a PeterPlate project lead.
+
+## Commits
+
+We follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/)
+specification for readable and consistent commit messages.
+
+To ensure compliance, we use [commitlint](https://commitlint.js.org/). Similar to
+our code formatting, commit message format is enforced by Husky before each commit.
diff --git a/content/docs/contributor/peterplate/getting-started.mdx b/content/docs/contributor/peterplate/getting-started.mdx
@@ -44,9 +44,9 @@ Make sure to have `docker` installed, which can be installed from [the official
 
 <Steps>
 <Step>
-Clone the ZotMeal repository from GitHub:
+Clone the PeterPlate repository from GitHub:
 ```bash
-git clone https://github.com/icssc/ZotMeal.git
+git clone https://github.com/icssc/PeterPlate.git
 ```
 </Step>
 
@@ -55,7 +55,7 @@ Navigate to the root directory and change your node version to the one specified
 </Step>
    
 <Step>
-While still in the root directory, install the dependencies by running `cd ZotMeal && pnpm install`.
+While still in the root directory, install the dependencies by running `cd PeterPlate && pnpm install`.
 </Step>
 
 <Step>
@@ -126,10 +126,10 @@ nvm use 20
 
 ## Structure Overview
 
-The following directory tree outlines the major folders in the ZotMeal repository:
+The following directory tree outlines the major folders in the PeterPlate repository:
 
 <Files>
-<Folder name="ZotMeal" defaultOpen>
+<Folder name="PeterPlate" defaultOpen>
 <Folder name="node_modules" />
    <Folder name="apps" defaultOpen>
       <Folder name="next" />
@@ -146,11 +146,11 @@ The following directory tree outlines the major folders in the ZotMeal repositor
 
 The `node_modules` folder contains all ***Node.js*** packages that the repository uses.
 
-The `apps` folder contains major endpoints that ZotMeal uses:
+The `apps` folder contains major endpoints that PeterPlate uses:
 - `apps/next` contains all of the frontend components and scripts used to build the web app, written in **Next.js**.
 - `apps/server` contains the scripts used to connect backend functions to AWS Lambda Serverless procedures.
 
-The `packages` folder contains all the functionality of the backend of ZotMeal.
+The `packages` folder contains all the functionality of the backend of PeterPlate.
 - `packages/api` contains all the ***tRPC** procedures used
 - `packages/db` contains the database schema (written using ***DrizzleORM***)
 - `packages/validators` contains information used for type verification of API schemas used in the backend (written using ***Zod***)
diff --git a/content/docs/contributor/peterplate/index.md b/content/docs/contributor/peterplate/index.md
@@ -1,12 +1,12 @@
 ---
-title: ZotMeal
+title: PeterPlate (Formerly ZotMeal)
 ---
 
 ## About
 
-Navigating UCI's dining options at Brandywine and the Anteatery is now simpler and more informed with ZotMeal. This comprehensive menu viewer, available as a website and mobile app, is designed to enhance your campus dining experience. UCI students use ZotMeal to plan their daily meals and track progress toward their nutritional goals.
+Navigating UCI's dining options at Brandywine and the Anteatery is now simpler and more informed with PeterPlate. This comprehensive menu viewer, available as a website and mobile app, is designed to enhance your campus dining experience. UCI students use PeterPlate to plan their daily meals and track progress toward their nutritional goals.
 
-Key features of ZotMeal include:
+Key features of PeterPlate include:
 
 - **_Detailed Menu Viewer_**: Browse current and upcoming menus, allowing you 
 to strategically plan your meal swipes and never miss your favorite dishes.
@@ -15,11 +15,11 @@ access to comprehensive ingredient and allergen details for every meal.
 - **_Event Calendar_**: Stay updated on special dining hall events and limited-time offerings.
 - **_Dish Ratings_**: Contribute your own feedback to help fellow Anteaters discover the best of campus dining.
 
-![A screenshot of the ZotMeal website homepage.](./zotmeal-screenshot.jpg)
+![A screenshot of the PeterPlate website homepage.](./peterplate-screenshot.jpg)
 
 ## Technology
 
-ZotMeal consists of a Next.JS frontend with a shared backend. A summary of the libraries used in each are listed below.
+PeterPlate consists of a Next.JS frontend with a shared backend. A summary of the libraries used in each are listed below.
 
 ### Frontend
 
@@ -41,4 +41,4 @@ ZotMeal consists of a Next.JS frontend with a shared backend. A summary of the l
 
 ## Contributing
 
-We'd be happy to have your contributions to ZotMeal -- we're always looking to grow and change! Please see [Getting Started](/docs/contributor/zotmeal/getting-started) to learn how to contribute effectively.
+We'd be happy to have your contributions to PeterPlate -- we're always looking to grow and change! Please see [Getting Started](/docs/contributor/peterplate/getting-started) to learn how to contribute effectively.
diff --git a/content/docs/contributor/peterplate/meta.json b/content/docs/contributor/peterplate/meta.json
@@ -0,0 +1,5 @@
+{
+  "title": "PeterPlate",
+  "icon": "UtensilsCrossed",
+  "pages": ["getting-started", "code-quality", "ui", "api"]
+}
diff --git a/content/docs/contributor/peterplate/peterplate-screenshot.jpg b/content/docs/contributor/peterplate/peterplate-screenshot.jpg
diff --git a/content/docs/contributor/peterplate/ui.mdx b/content/docs/contributor/peterplate/ui.mdx
@@ -1,10 +1,12 @@
 ---
 title: UI
+icon: Paintbrush
 ---
 
 import { File, Folder, Files } from "fumadocs-ui/components/files";
+import {Callout} from "fumadocs-ui/components/callout";
 
-ZotMeal's frontend -- written in the [Next.js](https://nextjs.org) framework.
+PeterPlate's frontend -- written in the [Next.js](https://nextjs.org) framework.
 
 
 # App Structure
@@ -26,9 +28,11 @@ The web app is contained in apps/next, which should look something like:
 </Folder>
 </Files>
 
-> A quick aside about `📂node_modules` and `📂public`: 
-> - `📂public` is for static data that needs serving, like images.
-> - `📂node_modules` is a folder that Node.js automatically generates for the packages used in development.
+<Callout>
+ A quick aside about `📂node_modules` and `📂public`: 
+ - `📂public` is for static data that needs serving, like images.
+ - `📂node_modules` is a folder that Node.js automatically generates for the packages used in development.
+</Callout>
 
 We will now go into detail about each subdirectory of `📂src`, which 
 comprise the whole of the frontend.
@@ -60,45 +64,45 @@ next to the tab name).
 
 ## 📂 Components
 
-All of the components used in ZotMeal's web app are defined in 
+All of the components used in PeterPlate's web app are defined in 
 `📂components`.
 
-ZotMeal extends a lot of the [shad/cn](https://ui.shadcn.com/) library's 
+PeterPlate extends a lot of the [shad/cn](https://ui.shadcn.com/) library's 
 components. As such, you may be better off looking at their documentation to 
-implement your own component for ZotMeal.
+implement your own component for PeterPlate.
 
 See the components in this folder for more details on each unique component.
 
 ## 📂 Context
 
 All of the [contexts](https://react.dev/learn/passing-data-deeply-with-context)
-used in ZotMeal's webapp are defined in `📂context`.
+used in PeterPlate's webapp are defined in `📂context`.
 
 Essentially, a context is a method of passing information between components
 without having to **prop drill**, or pass props deeply into children that may
 or may not use those props. See the link above for React context information.
 
 ## 📂 Hooks
 
-All of the [hooks](https://react.dev/reference/react/hooks) used in ZotMeal's
+All of the [hooks](https://react.dev/reference/react/hooks) used in PeterPlate's
 webapp are defined in `📂hooks`.
 
 See the link above for more information on React hooks.
 
 ## 📂 Utils
 
 Functions, types, constants, and other static information/tools used across
-ZotMeal's webapp are defined in `📂utils`.
+PeterPlate's webapp are defined in `📂utils`.
 
 ## Defining Your Own Folder
 
 If for some reason you find yourself writing a file that doesn't fit within the
-predefined folders above, please reach out to a current ZotMeal lead to figure
+predefined folders above, please reach out to a current PeterPlate lead to figure
 out whether a new folder needs to be created for organization. 
 
 # Backend Integration
 
-ZotMeal leverages a tRPC backend, which queries a local Postgres database. 
+PeterPlate leverages a tRPC backend, which queries a local Postgres database. 
 This database has cron jobs run on it that pull CampusDish data daily and 
 weekly for dishes and events.
 
diff --git a/content/docs/contributor/zotmeal/meta.json b/content/docs/contributor/zotmeal/meta.json
