From e2dc4a04c407d541bf615fefa350b8f8eb225398 Mon Sep 17 00:00:00 2001
From: cdeng65 <cdeng65@gatech.edu>
Date: Fri, 29 Sep 2023 03:47:21 -0400
Subject: [PATCH] new docs

---
 src/screens/AnonDocs/Docs.tsx | 252 ++++++++++++++++++++++++++++++++++
 1 file changed, 252 insertions(+)
 create mode 100644 src/screens/AnonDocs/Docs.tsx

diff --git a/src/screens/AnonDocs/Docs.tsx b/src/screens/AnonDocs/Docs.tsx
new file mode 100644
index 0000000..0d0271a
--- /dev/null
+++ b/src/screens/AnonDocs/Docs.tsx
@@ -0,0 +1,252 @@
+import React from "react";
+import {
+  Box,
+  Flex,
+  Link,
+  Heading,
+  Text,
+  Container,
+  Image,
+  Icon,
+  Code,
+} from "@chakra-ui/react";
+import { FaArrowCircleRight } from "react-icons/fa";
+
+const Documentation: React.FC = () => {
+  return (
+    <Box bg="#F9FAFC">
+      <Flex
+        as="nav"
+        align="center"
+        justify="center"
+        wrap="wrap"
+        padding={6}
+        bg="teal.500"
+        position="sticky"
+        top={0}
+        zIndex={1000}
+      >
+        <Box
+          flexBasis={{ base: "100%", md: "auto" }}
+          flexGrow={1}
+          textAlign={{ base: "center", md: "left" }}
+        >
+          <Heading fontSize="3xl" color="black" mr={2}>
+            Advanced Reasoning Benchmark
+          </Heading>
+        </Box>
+      </Flex>
+
+      <Container maxW="container.xl" py={8}>
+        <Heading as="h2" size="xl" mb={6}>
+          API Documentation
+        </Heading>
+        <Text mb={4}>
+          We provide a simple API to access the Advanced Reasoning Benchmark
+          (ARB). The API currently supports standard HTTP GET requests.
+        </Text>
+
+        <Heading as="h2" size="xl" mb={6}>
+          API Calls
+        </Heading>
+        <Text mb={4}>
+          We have three different types of API calls for retrieving problems.
+          See{" "}
+          <Link
+            href="https://app.swaggerhub.com/apis-docs/arb-dataset/arb-api/1.0.5"
+            color="teal.500"
+          >
+            here
+          </Link>{" "}
+          and select ARB API server as the mock server to see what the outputs
+          look like.
+        </Text>
+
+        <Heading as="h3" size="lg" mb={4}>
+          Get problem by category:
+        </Heading>
+        <Text mb={4}>
+          You can retrieve all the problems in a particular subject area by the
+          following API call. Acceptable values for `category` are `law`,
+          `math`, `mcatReading`, etc.
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}</Code>
+        </Box>
+        <Text fontWeight="bold" mb={2}>
+          Math Numerical:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/math&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          Math Symbolic:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/math/symbolic&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          Math Proofs:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/math/proof&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          Physics Numerical:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/physics/val&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          Physics Symbolic:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/physics/val&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          Law:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/law&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Text fontWeight="bold" mb={2}>
+          MCAT Reading:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/mcatReading&quot;)
+            <br />
+            data = response.json()
+          </Code>
+        </Box>
+
+        <Heading as="h3" size="lg" mb={4}>
+          Get a specific problem by id within category
+        </Heading>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}/{"{id}"}
+          </Code>
+        </Box>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/math/1234&quot;)
+            <br />
+            problem = response.json()
+          </Code>
+        </Box>
+
+        <Heading as="h3" size="lg" mb={4}>
+          Get problem by category variation (e.g. img vs val)
+        </Heading>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            https://advanced-reasoning-benchmark.netlify.app/api/lib/{"{category}"}/{"{variation}"}
+          </Code>
+        </Box>
+        <Text fontWeight="bold" mb={2}>
+          Physics Numerical w/ Images:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/physics_numerical/img&quot;)
+            <br />
+            variation_data = response.json()
+          </Code>
+        </Box>
+        <Text fontWeight="bold" mb={2}>
+          Physics Symbolic w/ Images:
+        </Text>
+        <Box p={4} mb={4} borderWidth="1px" borderRadius="md" bg="gray.50">
+          <Code>
+            import requests
+            <br />
+            response =
+            requests.get(&quot;https://advanced-reasoning-benchmark.netlify.app/api/lib/testSplit/physics/img&quot;)
+            <br />
+            variation_data = response.json()
+          </Code>
+        </Box>
+      </Container>
+
+      <Flex
+        as="footer"
+        align="center"
+        justify="center"
+        wrap="wrap"
+        padding={6}
+        bg="teal.500"
+      >
+        <Link
+          href="/docs"
+          color="white"
+          textDecoration="underline"
+          _hover={{ color: "white", textDecoration: "underline" }}
+        >
+          <Text fontWeight="bold" fontSize="md">
+            Copyright © 2023 The ARB Team
+          </Text>
+        </Link>
+      </Flex>
+    </Box>
+  );
+};
+
+export default Documentation;