Added a documentation folder for Github pages

docs/.prettierignore

@@ -0,0 +1,3 @@
+node_modules/
+dist/
+.astro/

docs/.prettierrc

@@ -0,0 +1,16 @@
+{
+    "plugins": ["prettier-plugin-astro"],
+    "overrides": [
+        {
+            "files": "*.astro",
+            "options": {
+                "parser": "astro"
+            }
+        }
+    ],
+    "printWidth": 100,
+    "tabWidth": 4,
+    "useTabs": false,
+    "singleQuote": true,
+    "trailingComma": "none"
+}

docs/astro.config.mjs

@@ -0,0 +1,53 @@
+import { defineConfig } from 'astro/config';
+import starlight from '@astrojs/starlight';
+
+export default defineConfig({
+    site: 'https://trickfirerobotics.github.io',
+    base: '/urc',
+    srcDir: './',
+    integrations: [
+        starlight({
+            title: 'TrickFire URC Documentation',
+            head: [
+                {
+                    tag: 'script',
+                    content: `
+                        if (!localStorage.getItem('starlight-theme')) {
+                            localStorage.setItem('starlight-theme', 'dark');
+                        }
+                    `
+                }
+            ],
+            logo: {
+                src: './assets/nav-logo.png',
+                alt: 'TrickFire Robotics Logo',
+                replacesTitle: true
+            },
+            favicon: '/favicon.ico',
+            social: [
+                {
+                    icon: 'github',
+                    label: 'GitHub',
+                    href: 'https://github.com/TrickfireRobotics/urc'
+                },
+                {
+                    icon: 'external',
+                    label: 'Notion',
+                    href: 'https://www.notion.so/trickfire/invite/7f153eec8ed8ebe4608dc95892fce859540f8640'
+                },
+                {
+                    icon: 'external',
+                    label: 'TrickFire Robotics',
+                    href: 'https://trickfirerobotics.github.io'
+                }
+            ],
+            sidebar: [
+                { label: 'Home', items: [{ label: 'Temporary Home', slug: 'temp/temp' }] },
+            ],
+            components: {
+                SocialIcons: './components/SocialIcons.astro'
+            },
+            customCss: ['./styles/custom.css']
+        })
+    ]
+});

docs/components/SocialIcons.astro

@@ -0,0 +1,49 @@
+---
+import config from 'virtual:starlight/user-config';
+
+const links = config.social || [];
+
+const icons: Record<string, string> = {
+    GitHub:
+        '<path d="M12 .3a12 12 0 0 0-3.8 23.38c.6.12.83-.26.83-.57L9 21.07c-3.34.72-4.04-1.61-4.04-1.61-.55-1.39-1.34-1.76-1.34-1.76-1.08-.74.09-.73.09-.73 1.2.09 1.83 1.24 1.83 1.24 1.08 1.83 2.81 1.3 3.5 1 .1-.78.42-1.31.76-1.61-2.67-.3-5.47-1.33-5.47-5.93 0-1.31.47-2.38 1.24-3.22-.14-.3-.54-1.52.1-3.18 0 0 1-.32 3.3 1.23a11.5 11.5 0 0 1 6 0c2.28-1.55 3.29-1.23 3.29-1.23.64 1.66.24 2.88.12 3.18a4.65 4.65 0 0 1 1.23 3.22c0 4.61-2.8 5.63-5.48 5.92.42.36.81 1.1.81 2.22l-.01 3.29c0 .31.2.69.82.57A12 12 0 0 0 12 .3Z"/>',
+    Notion:
+        '<path d="M4.459 4.208c.746.606 1.026.56 2.428.466l13.215-.793c.28 0 .047-.28-.046-.326L17.86 1.968c-.42-.326-.981-.7-2.055-.607L3.01 2.295c-.466.046-.56.28-.374.466zm.793 3.08v13.904c0 .747.373 1.027 1.214.98l14.523-.84c.841-.046.935-.56.935-1.167V6.354c0-.606-.233-.933-.748-.887l-15.177.887c-.56.047-.747.327-.747.933zm14.337.745c.093.42 0 .84-.42.888l-.7.14v10.264c-.608.327-1.168.514-1.635.514-.748 0-.935-.234-1.495-.933l-4.577-7.186v6.952L12.21 19s0 .84-1.168.84l-3.222.186c-.093-.186 0-.653.327-.746l.84-.233V9.854L7.822 9.76c-.094-.42.14-1.026.793-1.073l3.456-.233 4.764 7.279v-6.44l-1.215-.139c-.093-.514.28-.887.747-.933zM1.936 1.035l13.31-.98c1.634-.14 2.055-.047 3.082.7l4.249 2.986c.7.513.934.653.934 1.213v16.378c0 1.026-.373 1.634-1.68 1.726l-15.458.934c-.98.047-1.448-.093-1.962-.747l-3.129-4.06c-.56-.747-.793-1.306-.793-1.96V2.667c0-.839.374-1.54 1.447-1.632z"/>',
+    'TrickFire Robotics':
+        '<circle cx="12" cy="12" r="10" fill="none" stroke="currentColor" stroke-width="2"/><line x1="2" y1="12" x2="22" y2="12" stroke="currentColor" stroke-width="2"/><path d="M12 2a15.3 15.3 0 0 1 4 10 15.3 15.3 0 0 1-4 10 15.3 15.3 0 0 1-4-10 15.3 15.3 0 0 1 4-10z" fill="none" stroke="currentColor" stroke-width="2"/>',
+};
+---
+
+{
+    links.length > 0 && (
+        <>
+            {links.map(({ label, href }) => (
+                <a {href} rel="me" class="sl-flex">
+                    <span class="sr-only">{label}</span>
+                    <svg
+                        aria-hidden="true"
+                        viewBox="0 0 24 24"
+                        fill="currentColor"
+                        set:html={icons[label] ?? icons['GitHub']}
+                    />
+                </a>
+            ))}
+        </>
+    )
+}
+
+<style>
+    @layer starlight.core {
+        a {
+            color: var(--sl-color-text-accent);
+            padding: 0.5em;
+            margin: -0.5em;
+        }
+        a:hover {
+            color: var(--sl-color-white);
+        }
+        svg {
+            width: 1em;
+            height: 1em;
+        }
+    }
+</style>

docs/content.config.ts

@@ -0,0 +1,7 @@
+import { defineCollection } from 'astro:content';
+import { docsLoader } from '@astrojs/starlight/loaders';
+import { docsSchema } from '@astrojs/starlight/schema';
+
+export const collections = {
+    docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }),
+};

docs/content/docs/index.mdx

@@ -0,0 +1,43 @@
+---
+title: TrickFire URC codebase documentation
+description: Documentation for the TrickFire Robotics Gazebo simulation environment.
+template: splash
+hero:
+  title: TrickFire URC
+  tagline: Documentation for the TrickFire Robotics URC codebase.
+  image:
+    html: '<img src="/urc/logo-small.png" alt="TrickFire Robotics Logo" class="hero-logo">'
+  actions:
+    - text: Get Started
+      link: /urc/temp/temp
+      icon: right-arrow
+    - text: View on GitHub
+      link: https://github.com/TrickfireRobotics/urc
+      icon: external
+      variant: minimal
+---
+
+import { CardGrid, LinkCard } from '@astrojs/starlight/components';
+
+<CardGrid>
+  <LinkCard
+    title="Temp"
+    description="Temp"
+    href="/urc/temp/temp/"
+  />
+  <LinkCard
+    title="Temp"
+    description="Temp"
+    href="/urc/temp/temp/"
+  />
+  <LinkCard
+    title="Temp"
+    description="Temp"
+    href="/urc/temp/temp/"
+  />
+  <LinkCard
+    title="Temp"
+    description="Temp"
+    href="/urc/temp/temp/"
+  />
+</CardGrid>

docs/content/docs/temp/temp.md

@@ -0,0 +1,6 @@
+---
+title: Placeholder
+description: placeholder
+---
+
+This is a placeholder. Delete this file after you are done with it.

docs/env.d.ts

@@ -0,0 +1 @@
+/// <reference path="../.astro/types.d.ts" />