feat: ✨ attribution page in about namespace (#23)

Author: ecxyzzy

app/(home)/page.tsx

@@ -1,30 +1,11 @@
-import { Card, Cards } from "fumadocs-ui/components/card";
-import { Brush, BookOpenText, ScrollText } from "lucide-react";
+import { Cards } from "fumadocs-ui/components/card";
+import { homePageCards } from "@/lib/categories";
 
 export default function HomePage() {
   return (
     <main className="p-4">
       <h1 className="mt-6 mb-4 text-2xl font-medium">Welcome to ICSSC</h1>
-      <Cards>
-        <Card
-          icon={<Brush />}
-          href="/docs/brand"
-          title="Brand Guide"
-          description="Logos, colors, topography, guidelines"
-        />
-        <Card
-          icon={<BookOpenText />}
-          href="/docs/developer"
-          title="Developer Docs"
-          description="Public facing developer projects"
-        />
-        <Card
-          icon={<ScrollText />}
-          href="/docs/contributor"
-          title="Contributor Docs"
-          description="Internal documentation and design reasoning"
-        />
-      </Cards>
+      <Cards>{...homePageCards}</Cards>
     </main>
   );
 }

app/docs/layout.tsx

@@ -1,12 +1,12 @@
 import { RootToggle } from "fumadocs-ui/components/layout/root-toggle";
 import { DocsLayout } from "fumadocs-ui/layouts/docs";
-import { BookOpenText, Brush, ScrollText } from "lucide-react";
 import type { ReactNode } from "react";
 import { headers } from "next/headers";
 
 import { baseOptions } from "../layout.config";
 
 import { source } from "@/app/source";
+import { categories } from "@/lib/categories";
 
 export function generateViewport() {
   const userAgent = headers().get("user-agent");
@@ -22,30 +22,7 @@ export default function Layout({ children }: { children: ReactNode }) {
   return (
     <DocsLayout
       sidebar={{
-        banner: (
-          <RootToggle
-            options={[
-              {
-                icon: <Brush />,
-                title: "Brand Guide",
-                description: "Logos, colors, topography, guidelines",
-                url: "/docs/brand",
-              },
-              {
-                icon: <BookOpenText />,
-                title: "Developer Docs",
-                description: "Public facing developer projects",
-                url: "/docs/developer",
-              },
-              {
-                icon: <ScrollText />,
-                title: "Contributor Docs",
-                description: "Internal documentation and design reasoning",
-                url: "/docs/contributor",
-              },
-            ]}
-          />
-        ),
+        banner: <RootToggle options={categories} />,
       }}
       tree={source.pageTree}
       {...baseOptions}

content/docs/about/anteaterapi.mdx

@@ -0,0 +1,50 @@
+---
+title: Anteater API
+---
+
+import { Accordion, Accordions } from 'fumadocs-ui/components/accordion';
+
+## What is Anteater API?
+
+Anteater API provides various data from the University of California, Irvine, in a structured format that can be used by other software.
+
+Anteater API is maintained by the ICS Student Council (ICSSC).
+
+## What is ICSSC?
+
+ICS Student Council is a far-reaching organization that aims to improve student life within and beyond the Donald Bren School of Information and Computer Sciences.
+
+## Getting Involved with ICSSC
+
+ICSSC typically hosts weekly events in DBH 6011 on Wednesdays from 7-8pm. All UCI affiliates are welcome to attend.
+
+You can learn about more ways to get involved [here](https://icssc.club/get-involved).
+
+## Using Anteater API in Your Software
+
+If you're building an application that manipulates public data provided by the school, the Anteater API likely has you covered.
+
+You can learn about the capabilities of Anteater API, and how to use it, [here](/docs/developer/anteaterapi).
+
+## Using Anteater API for Research
+
+Anteater API contains a wealth of historical data that could be useful in your research endeavors. The following is a non-exhaustive list of the historical data we have, as well as the earliest term for which we have this data.
+<Accordions>
+  <Accordion title="Schedule of Classes">
+    Since Fall 1990.
+  </Accordion>
+  <Accordion title="Grade distributions">
+    Since Summer 2014.
+  </Accordion>
+  <Accordion title="Course enrollment trends">
+    Since Winter 2022.
+  </Accordion>
+</Accordions>
+
+If there's more data that you'd like to see us provide for your research project, and such data can be obtained publicly, please don't hesitate to reach out.
+
+## Contributing to Anteater API
+
+Anteater API is free and open-source software (FOSS). The word "free" in this context is as in free speech, though there is also no monetary cost to use Anteater API. This means that everyone can view its source code to see how it works, and everyone is allowed to contribute to Anteater API and/or redistribute its source code.
+
+The Anteater API team also regularly extends invitations to active contributors who are not part of Projects Committee.

content/docs/about/index.md

@@ -0,0 +1,3 @@
+---
+title: About
+---

content/docs/about/meta.json

@@ -0,0 +1,4 @@
+{
+  "pages": ["---Projects---", "anteaterapi"],
+  "root": true
+}

content/docs/developer/anteaterapi/attribution-policy.mdx

@@ -8,16 +8,16 @@ This attribution policy applies to you if you use data from the instance of Ante
 
 ## Applications
 
-If you use Anteater API in an application, please include the following attribution in a prominent location in relevant contexts. This includes areas where a user is prompted to enter a query that leads to data provided by the API, and areas where data from Anteater API is displayed. Whenever possible, link to https://anteaterapi.com/attribution when referencing Anteater API.
+If you use Anteater API in an application, please include the following attribution in a prominent location in relevant contexts. This includes areas where a user is prompted to enter a query that leads to data provided by the API, and areas where data from Anteater API is displayed. Whenever possible, link to https://icssc.link/about-anteaterapi when referencing Anteater API.
 
 ### Search Bar
 
 - Search Anteater API for Courses
 
 ### Data
 
-- Data from [Anteater API](https://anteaterapi.com/attribution)
-- Courses from [Anteater API](https://anteaterapi.com/attribution)
+- Data from [Anteater API](https://icssc.link/about-anteaterapi)
+- Courses from [Anteater API](https://icssc.link/about-anteaterapi)
 
 ## Academic Work
 

lib/categories.tsx

@@ -0,0 +1,38 @@
+import { Card } from "fumadocs-ui/components/card";
+import type { Option } from "fumadocs-ui/components/layout/root-toggle";
+import { BookA, BookOpenText, Brush, ScrollText } from "lucide-react";
+
+interface RootToggleOption extends Option {
+  title: string;
+}
+
+export const categories: RootToggleOption[] = [
+  {
+    icon: <BookA />,
+    title: "About",
+    description: "Introductory information about us and our projects",
+    url: "/docs/about",
+  },
+  {
+    icon: <BookOpenText />,
+    title: "Developer Docs",
+    description: "Public facing developer projects",
+    url: "/docs/developer",
+  },
+  {
+    icon: <ScrollText />,
+    title: "Contributor Docs",
+    description: "Internal documentation and design reasoning",
+    url: "/docs/contributor",
+  },
+  {
+    icon: <Brush />,
+    title: "Brand Guide",
+    description: "Logos, colors, topography, guidelines",
+    url: "/docs/brand",
+  },
+];
+
+export const homePageCards = categories.map(({ icon, title, description, url }) => (
+  <Card key={title} icon={icon} title={title} description={description} href={url} />
+));