Move from main repo

Author: Benny-Nottonson

.gitignore

@@ -0,0 +1,36 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+.yarn/install-state.gz
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo
+next-env.d.ts

README.md

@@ -0,0 +1,36 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+# or
+pnpm dev
+# or
+bun dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `app/page.tsx`. The page auto-updates as you edit the file.
+
+This project uses [`next/font`](https://nextjs.org/docs/basic-features/font-optimization) to automatically optimize and load Inter, a custom Google Font.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

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

@@ -0,0 +1,63 @@
+import ModuleCard from "@/components/module-card";
+import Sidebar from "@/components/sidebar";
+import {
+  Breadcrumb,
+  BreadcrumbList,
+  BreadcrumbItem,
+  BreadcrumbLink,
+  BreadcrumbSeparator,
+} from "@/components/ui/breadcrumb";
+import { findPackage } from "@/lib/docs";
+import React, { Fragment, useMemo } from "react";
+
+export default function Package({ params }: { params: { pkg: string[] } }) {
+  const Crumbs = useMemo(() => {
+    const generateHref = (index: number) => {
+      return `/docs/${params.pkg.slice(0, index + 1).join("/")}`;
+    };
+
+    return (
+      <Breadcrumb className="text-primary font-semibold p-4">
+        <BreadcrumbList>
+          <BreadcrumbItem>
+            <BreadcrumbLink href="/">Home</BreadcrumbLink>
+          </BreadcrumbItem>
+          {params.pkg.map((pkg, index) => (
+            <Fragment key={pkg}>
+              <BreadcrumbSeparator />
+              <BreadcrumbItem>
+                <BreadcrumbLink
+                  href={generateHref(index)}
+                  className="capitalize"
+                >
+                  {pkg}
+                </BreadcrumbLink>
+              </BreadcrumbItem>
+            </Fragment>
+          ))}
+        </BreadcrumbList>
+      </Breadcrumb>
+    );
+  }, [params.pkg]);
+
+  const pkg = findPackage(params.pkg);
+
+  if (!pkg) {
+    return <div>Package not found</div>;
+  }
+
+  const modules = pkg.modules || [];
+
+  return (
+    <main>
+      <div className="flex items-center h-full">
+        <Sidebar pkg={pkg} />
+        <div className="w-4/5 p-4 grid grid-cols-1 gap-4 translate-x-1/4">
+          {modules.length > 0 &&
+            modules.map((mdl) => <ModuleCard mdl={mdl} key={mdl.name} />)}
+        </div>
+      </div>
+      <div className="fixed bottom-0 right-0">{Crumbs}</div>
+    </main>
+  );
+}

app/favicon.ico

@@ -0,0 +1,76 @@
+@tailwind base;
+@tailwind components;
+@tailwind utilities;
+
+@layer base {
+  :root {
+    --background: 0 0% 100%;
+    --foreground: 0 0% 3.9%;
+
+    --card: 0 0% 100%;
+    --card-foreground: 0 0% 3.9%;
+
+    --popover: 0 0% 100%;
+    --popover-foreground: 0 0% 3.9%;
+
+    --primary: 0 0% 9%;
+    --primary-foreground: 0 0% 98%;
+
+    --secondary: 0 0% 96.1%;
+    --secondary-foreground: 0 0% 9%;
+
+    --muted: 0 0% 96.1%;
+    --muted-foreground: 0 0% 45.1%;
+
+    --accent: 0 0% 96.1%;
+    --accent-foreground: 0 0% 9%;
+
+    --destructive: 0 84.2% 60.2%;
+    --destructive-foreground: 0 0% 98%;
+
+    --border: 0 0% 89.8%;
+    --input: 0 0% 89.8%;
+    --ring: 0 0% 3.9%;
+
+    --radius: 0.5rem;
+  }
+
+  .dark {
+    --background: 0 0% 3.9%;
+    --foreground: 0 0% 98%;
+
+    --card: 0 0% 3.9%;
+    --card-foreground: 0 0% 98%;
+
+    --popover: 0 0% 3.9%;
+    --popover-foreground: 0 0% 98%;
+
+    --primary: 0 0% 98%;
+    --primary-foreground: 0 0% 9%;
+
+    --secondary: 0 0% 14.9%;
+    --secondary-foreground: 0 0% 98%;
+
+    --muted: 0 0% 14.9%;
+    --muted-foreground: 0 0% 63.9%;
+
+    --accent: 0 0% 14.9%;
+    --accent-foreground: 0 0% 98%;
+
+    --destructive: 0 62.8% 30.6%;
+    --destructive-foreground: 0 0% 98%;
+
+    --border: 0 0% 14.9%;
+    --input: 0 0% 14.9%;
+    --ring: 0 0% 83.1%;
+  }
+}
+
+@layer base {
+  * {
+    @apply border-border;
+  }
+  body {
+    @apply bg-background text-foreground;
+  }
+}

app/globals.css

@@ -0,0 +1,35 @@
+import type { Metadata } from "next";
+import { Inter } from "next/font/google";
+import "./globals.css";
+import { ThemeProvider } from "@/components/theme-provider";
+import Navbar from "@/components/navbar";
+
+const inter = Inter({ subsets: ["latin"] });
+
+export const metadata: Metadata = {
+  title: "Basalt Docs",
+  description:
+    "Public documentation for the Basalt machine learning framework.",
+};
+
+export default function RootLayout({
+  children,
+}: Readonly<{
+  children: React.ReactNode;
+}>) {
+  return (
+    <html lang="en" suppressHydrationWarning>
+      <body className={inter.className}>
+        <ThemeProvider
+          attribute="class"
+          defaultTheme="system"
+          enableSystem
+          disableTransitionOnChange
+        >
+          <Navbar />
+          {children}
+        </ThemeProvider>
+      </body>
+    </html>
+  );
+}

app/layout.tsx

@@ -0,0 +1,37 @@
+import { Button } from "@/components/ui/button";
+import {
+  Card,
+  CardContent,
+  CardDescription,
+  CardHeader,
+  CardTitle,
+} from "@/components/ui/card";
+import Docs from "@/docs.json";
+import Link from "next/link";
+
+export default function Home() {
+  return (
+    <main className="flex items-center justify-center pt-32">
+      <div className="w-full max-w-6xl grid grid-cols-1 md:grid-cols-3 gap-16">
+        {Docs.decl.packages.map((pkg) => (
+          <Card className="w-full flex flex-col" key={pkg.name}>
+            <CardHeader>
+              <CardTitle>{pkg.name}</CardTitle>
+              <CardDescription className="capitalize">
+                {[...pkg.modules, ...pkg.packages]
+                  .map((item) => item.name)
+                  .join(", ")}
+              </CardDescription>
+            </CardHeader>
+            <CardContent className="flex-grow">{pkg.description}</CardContent>
+            <div className="mt-4 p-4">
+              <Button className="w-full sm:w-auto" variant="ghost">
+                <Link href={`/docs/${pkg.name}`}>View Documentation</Link>
+              </Button>
+            </div>
+          </Card>
+        ))}
+      </div>
+    </main>
+  );
+}

app/page.tsx

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://ui.shadcn.com/schema.json",
+  "style": "default",
+  "rsc": true,
+  "tsx": true,
+  "tailwind": {
+    "config": "tailwind.config.ts",
+    "css": "app/globals.css",
+    "baseColor": "neutral",
+    "cssVariables": true,
+    "prefix": ""
+  },
+  "aliases": {
+    "components": "@/components",
+    "utils": "@/lib/utils"
+  }
+}

bun.lockb

@@ -0,0 +1,41 @@
+"use client";
+
+import { Function } from "@/lib/docs";
+import { Card, CardContent, CardHeader, CardTitle } from "./ui/card";
+import { Dialog, DialogContent, DialogTrigger } from "./ui/dialog";
+
+export default async function FunctionCard({ func }: { func: Function }) {
+  const { name, overloads } = func;
+  const { constraints, isStatic, summary } = overloads![0];
+  const signatures = overloads!.map((overload) => overload.signature);
+
+  return (
+    <Dialog>
+      <div>
+        <DialogTrigger>{name}</DialogTrigger>
+      </div>
+      <DialogContent className="sm:max-w-md">
+        <Card>
+          <CardHeader>
+            <CardTitle>{name}</CardTitle>
+            {summary && <p>{summary}</p>}
+            {isStatic && <p>Static</p>}
+            {constraints && <p>{constraints}</p>}
+          </CardHeader>
+          <CardContent>
+            <ul>
+              {signatures.map((signature) => (
+                <li
+                  key={signature}
+                  className={"p-2 my-2 bg-gray-100 dark:bg-gray-800 rounded-md"}
+                >
+                  <code>{signature}</code>
+                </li>
+              ))}
+            </ul>
+          </CardContent>
+        </Card>
+      </DialogContent>
+    </Dialog>
+  );
+}