From f270b70b9d24adac3944e3f929df901dace08db7 Mon Sep 17 00:00:00 2001
From: arzafran <franco@darkroom.engineering>
Date: Mon, 25 Nov 2024 09:46:15 -0300
Subject: [PATCH] add llms.txt

---
 PROD-README.md  | 39 +++++++++++++-----------------
 public/llms.txt | 64 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 80 insertions(+), 23 deletions(-)
 create mode 100644 public/llms.txt

diff --git a/PROD-README.md b/PROD-README.md
index 3cf40b1..1fbe1a6 100644
--- a/PROD-README.md
+++ b/PROD-README.md
@@ -20,47 +20,40 @@ The usual process for Next.js based apps/websites:
 
 ## Stack:
 
-- [Lenis](https://github.com/darkroomengineering/lenis)
-- [Tempus](https://github.com/darkroomengineering/tempus)
-- [Hamo](https://github.com/darkroomengineering/hamo)
 - [PNPM](https://pnpm.io/)
 - [Next.js](https://nextjs.org/)
 - [Three.js](https://threejs.org/)
 - [@react-three/drei](https://github.com/pmndrs/drei)
 - [@react-three/fiber](https://docs.pmnd.rs/react-three-fiber/getting-started/introduction)
-- [GSAP](https://greensock.com/gsap/)
-- CSS with PostCSS custom settings (check `postcss.config.mjs`)
-- [Zustand](https://github.com/pmndrs/zustand)
-- GraphQL (CMS API)
-- [@svgr/webpack](https://github.com/gregberge/svgr/tree/main) (SVG Imports in `next.config.ts`)
-- [pnpm](https://pnpm.io/)
+- [Theatre.js](https://www.theatrejs.com/) (Animation tooling)
+- [Storyblok](https://www.storyblok.com/) (CMS)
+- [Shopify](https://www.shopify.com/) (E-commerce)
+- CSS Modules with PostCSS custom settings (check `postcss.config.mjs`)
+- [Biome](https://biomejs.dev/) (Linting & Formatting)
+- [Husky](https://typicode.github.io/husky/) (Git hooks)
+- [Storybook](https://storybook.js.org/) (Component development)
 
 ## Code Style & Linting:
 
-- [Biome](https://github.com/biomejs/biome)
 - [Lefthook](https://github.com/evilmartians/lefthook)
+- [Biome](https://biomejs.dev/)
 
 ## Third Party (optional tools):
 
-- [Storyblok CMS](https://storyblok.com/)
-- [Mailchimp CRM](https://mailchimp.com/)
-- [Hubspot CRM](https://hubspot.com/)
 - [Vercel (Hosting & Continuous Deployment)](https://vercel.com/home)
 - [GitHub Versioning](https://github.com/)
+- [Storyblok CMS](https://www.storyblok.com/)
+- [Shopify](https://www.shopify.com/)
 
 ## Folder Structure:
 
 Alongside the usual Next.js App Router folder structure (`/public`, `/app`, etc.) We've added a few other folders to keep the code easier to read:
 
-- **/components:** Reusable components with their respective CSS file
-- **/docs:** Readmes on how to use third party tools at darkroom
-- **/hooks:** Reusable Custom Hooks
-- **/libs:** 
-  - Core form functionality
-  - Hubspot integration
-  - Shopify integration
+- **/components:** Reusable components with their respective CSS modules
+- **/app/(pages):** Page components and layouts
+  - **/r3f:** Three.js/React Three Fiber components
+- **/libs:** Core functionality and integrations
   - Storyblok integration
-  - Style variables
+  - Shopify integration
   - Theatre.js integration
-  - general purpose functions
-- **/styles:** Style theme configurations, Global styles and CSS partials.
+  - WebGL utilities
diff --git a/public/llms.txt b/public/llms.txt
new file mode 100644
index 0000000..cd8614e
--- /dev/null
+++ b/public/llms.txt
@@ -0,0 +1,64 @@
+# Project Overview
+Next.js application with R3F (React Three Fiber), Storyblok CMS, and Shopify integration.
+
+# Key Technologies
+- Next.js (App Router)
+- PNPM for package management
+- React Three Fiber/Three.js/Drei for 3D
+- CSS Modules with PostCSS
+- Storyblok for CMS
+- Shopify for e-commerce
+- Theatre.js for animation
+- Biome for linting/formatting
+- Storybook for component development
+- Husky for git hooks
+- Lefthook for git hooks
+
+# Project Structure
+/app/(pages)/ - Page components and layouts
+  /r3f/ - Three.js/R3F components
+/components/ - Reusable components with CSS modules
+/libs/ - Core functionality and integrations
+  - Storyblok integration
+  - Shopify integration
+  - Theatre.js integration
+  - WebGL utilities
+/docs/ - Documentation for third-party tools
+/styles/ - Global styles and theme config
+
+# Setup Process
+1. Install dependencies: `pnpm i`
+2. Install Vercel CLI and get env variables:
+   - `vc link`
+   - `vc env pull`
+3. Run dev environment: `pnpm dev`
+
+# Development Workflow
+1. Uses PNPM for package management
+2. Requires env variables from Vercel
+3. Uses both Husky and Lefthook for git hooks
+4. Biome for code formatting/linting
+5. Storybook for component development
+
+# Key Features
+- WebGL/3D capabilities via R3F and Drei
+- CMS integration with Storyblok
+- E-commerce functionality via Shopify
+- Animation system using Theatre.js
+- Debug mode accessible at /debug/orchestra
+- CSS Modules with custom PostCSS config
+
+# Code Conventions
+- CSS Modules for styling (with PostCSS custom settings)
+- Biome for code formatting
+- Component-based architecture
+- Next.js App Router conventions
+- TypeScript for type safety
+
+# Important Notes
+- Debug panel available at /debug/orchestra
+- Uses Vercel for deployment
+- Requires specific env variables (see .env.template)
+- GSAP Business version requires auth token
+- Components should have accompanying CSS modules
+- Uses both Husky and Lefthook for git hooks
\ No newline at end of file