feat: api docs (#22)

* chore: gitignore .idea/

* feat: ✨ api docs

* feat: ✨ more ts-integration stuff

* feat: ✨ set up fumadocs-twoslash

* chore: 🔧 get husky to stop yelling at me

* feat: ✨ fix twoslash, finish ts-integration

* chore: 🔧 remove callout import

* chore: 🔧 move to anteaterapi.com/reference

Author: ecxyzzy

.gitignore

@@ -28,4 +28,7 @@ yarn-error.log*
 next-env.d.ts
 
 .worker-next
-.wrangler
+.wrangler
+
+# jetbrains
+.idea/

.husky/commit-msg

@@ -1,5 +1,2 @@
-#!/usr/bin/env bash
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no -- commitlint --edit
 npx --no -- devmoji --edit --config devmoji.config.cjs

.husky/pre-commit

@@ -1,4 +1 @@
-#!/usr/bin/env bash
-. "$(dirname -- "$0")/_/husky.sh"
-
 npx --no -- lint-staged

app/docs/[[...slug]]/page.tsx

@@ -1,5 +1,6 @@
 import defaultMdxComponents from "fumadocs-ui/mdx";
 import { DocsPage, DocsBody, DocsDescription, DocsTitle } from "fumadocs-ui/page";
+import { Popup, PopupContent, PopupTrigger } from "fumadocs-twoslash/ui";
 import { notFound } from "next/navigation";
 
 import { source } from "@/app/source";
@@ -24,6 +25,9 @@ export default async function Page({
         <MDX
           components={{
             ...defaultMdxComponents,
+            Popup,
+            PopupContent,
+            PopupTrigger,
           }}
         />
       </DocsBody>

app/layout.tsx

@@ -1,3 +1,4 @@
+import "fumadocs-twoslash/twoslash.css";
 import "./global.css";
 import { RootProvider } from "fumadocs-ui/provider";
 import { Inter } from "next/font/google";

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

@@ -2,11 +2,13 @@
 title: Attribution Policy
 ---
 
-This attribution policy applies to you if you use our hosted instance of Anteater API or use data from our API. If you opt to host your own instance of Anteater API, please see the [LICENSE](https://github.com/icssc/anteater-api?tab=AGPL-3.0-1-ov-file#readme) for requirements that may apply to you.
+Thank you for considering Anteater API for your next project! We're glad to be able to help you in your endeavors.
+
+This attribution policy applies to you if you use data from the instance of Anteater API we host at https://anteaterapi.com. If you opt to host your own instance of Anteater API, please see the [LICENSE](https://github.com/icssc/anteater-api?tab=AGPL-3.0-1-ov-file#readme) for requirements that may apply to you.
 
 ## Applications
 
-If you use Anteater API for 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 API provided data, 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://anteaterapi.com/attribution when referencing Anteater API.
 
 ### Search Bar
 

content/docs/developer/anteaterapi/fair-use-policy.mdx content/docs/developer/anteaterapi/best-practices.mdx

@@ -1,20 +1,18 @@
 ---
-title: Fair Use Policy
+title: Best Practices
 ---
 
 import { Tab, Tabs } from "fumadocs-ui/components/tabs";
 
-Thank you for considering Anteater API for your next project! We're glad to be able to help you in your endeavors.
-
-Before proceeding, please read through this page in its entirety. By sending a request to the API, it means that you have done so and accept all of its terms.
-
 ## Rate Limits
 
-Rate limits for Anteater API are enforced on a per key, per IP basis. However, our goal with these rate limit is to support almost all applications while preventing abuse. We understand that student projects, especially those made for a hackathon, may experience sudden traffic spikes, and have ensured our rate limits are much higher than what is necessary for almost all applications. If your application requires a higher rate limit, we will evaluate your use case and may choose to increase your rate limit.
+You may use most features of Anteater API without requesting an API key. Requests made without keys are subject to a per-IP basis and also draws from a global quota that is replenished on an hourly basis. If the global quota is exhausted, only requests with valid API keys will be accepted, so we recommend that you request an API key [here](https://dashboard.anteaterapi.com).
+
+Rate limits for Anteater API are enforced on a per-key basis otherwise. However, our goal with these rate limits is to support almost all applications while preventing abuse. We understand that student projects, especially those made for a hackathon, may experience sudden traffic spikes, and have ensured our rate limits are much higher than what is necessary for almost all applications. If your application requires a higher rate limit, we will evaluate your use case and may choose to increase your rate limit.
 
 With that being said, we ask that all developers refrain from purposefully sending large amounts of requests in a short interval, or making malicious requests with the intent to exploit vulnerabilities in the API. We reserve the right to blacklist IP addresses making such requests.
 
-If you do believe you have discovered a security vulnerability in Anteater API, please open an issue [here](https://github.com/icssc/anteater-api). Since we do not serve sensitive data, there is no need to report such issues confidentially, nor is there an email address for such purposes.
+If you do believe you have discovered a security vulnerability in Anteater API, please open an issue [here](https://github.com/icssc/anteater-api/issues). Since we do not serve sensitive data, there is no need to report such issues confidentially, nor is there an email address for such purposes.
 
 ## Setting the `Referer` header
 

content/docs/developer/anteaterapi/index.mdx

@@ -4,7 +4,7 @@ title: Anteater API
 
 import { Accordion, Accordions } from "fumadocs-ui/components/accordion";
 
-Anteater API is an API maintained by ICSSC Projects that provides various UCI related data. All the data served through Anteater API is publicly accessible, or derived from historically publicly accessible data. If you use our hosted API in your project, or use data obtained though Anteater API, please give us credit in accordance to our [Attribution Policy](/docs/developer/anteaterapi/attribution-policy).
+Anteater API is an API maintained by ICSSC Projects that provides various UCI related data. All the data served through Anteater API is publicly accessible, or derived from historically publicly accessible data. If you use data obtained though Anteater API in your project, please give us credit in accordance to our [Attribution Policy](/docs/developer/anteaterapi/attribution-policy).
 
 You are currently reading the **Developer Docs** for Anteater API. This part of the documentation covers how to properly integrate Anteater API into your own projects. If you're a developer who's interested in helping to improve Anteater API, please refer to the Anteater API [Contributor Docs](/docs/contributor/anteaterapi/getting-started-contributor).
 
@@ -26,7 +26,7 @@ You are currently reading the **Developer Docs** for Anteater API. This part of
 
   </Accordion>
   <Accordion title="How do I start using Anteater API?">
-    Unlike some other Web APIs, Anteater API does not require API keys or authentication, so you can start using this API immediately. However, in order to ensure a good experience for all users of the API, we ask that you read and abide by the [Fair Use Policy](fair-use-policy).
+    Unlike some other Web APIs, Anteater API does not require API keys or authentication, so you can start using this API immediately. However, in order to ensure a good experience for all users of the API, we ask that you read and abide by the [Attribution Policy](attribution-policy).
 
   </Accordion>
 </Accordions>

content/docs/developer/anteaterapi/meta.json

@@ -1,5 +1,5 @@
 {
   "title": "Anteater API",
   "icon": "Workflow",
-  "pages": ["fair-use-policy", "attribution-policy", "api-versioning", "rest-api", "graphql-api"]
+  "pages": ["attribution-policy", "best-practices", "api-versioning", "rest-api", "graphql-api"]
 }