doc

Author: zbeyens

CHANGELOG.md

@@ -1,5 +1,21 @@
 # Changelog
 
+## 1.1.0
+
+- New folder [session](session):
+  - [start-session](session/start-session.md)
+  - [end-session](session/end-session.md)
+- New folder [blueprints](blueprints):
+  - [supabase-drizzle-actions](blueprints/supabase-drizzle-actions.md) by @mckaywrigley
+  - [flux-with-replicate](blueprints/flux-with-replicate.md) by @mckaywrigley
+- New folder [plugins](plugins):
+  - [v0](plugins/v0.md) by @mckaywrigley
+- New folder [lib](lib):
+  - [nuqs](lib/nuqs.md) example for library usage
+
 ## [email protected]
 
-- Initial codex
+- New folder [codex](codex):
+  - [codex.md](codex/codex.md)
+  - [learn.md](codex/learn.md)
+  - [split-codex.md](codex/split-codex.md)

README.md

@@ -12,30 +12,68 @@ This folder contains AI-assisted development tools for improving code quality an
 
 ### Files
 
-- `codex.md`: AI Codex - A repository of learnings and errors.
-- `learn.md`: AI Learn - Protocol for updating the AI Codex.
+- [codex.md](codex/codex.md): AI Codex - A repository of learnings and errors.
+- [learn.md](codex/learn.md): AI Learn - Protocol for updating the AI Codex.
 
 ### Usage
 
-1. Review the Codex: `@codex.md` (silent load, no output)
-2. Update the Codex: `@learn.md`
+1. Review the Codex: [codex.md](codex/codex.md) (silent load, no output)
+2. Update the Codex: [learn.md](codex/learn.md)
 
 ### Important Note
 
-@codex.md should be added to the context of every chat:
+[codex.md](codex/codex.md) should be added to the context of every chat:
 
 - For regular chats: Use the plus button at the top of the chat to add the file.
 - For Composers: Add the file to a Project Composer so all Composers created in that project will automatically have the file.
 
 ### Structure
 
-The Codex (`codex.md`) is divided into two main sections:
+The [Codex](codex/codex.md) is divided into two main sections:
 
 1. Errors: Mistakes made and how to prevent them.
 2. Learnings: Insights gained and their applications.
 
 Each entry includes context, description, correction/application, and related entries.
 
+## Session
+
+- [start-session.md](session/start-session.md): Initiates a new AI session
+- [end-session.md](session/end-session.md): Concludes the current AI session
+
+Session files create a "memory layer" for the AI across multiple interactions, enabling contextual awareness and adaptive assistance.
+
+Key benefits:
+
+- Maintains project context between sessions
+- Reduces repetition of project details
+- Provides consistent guidance aligned with project direction
+
+Usage:
+
+1. End a session: Use [@end-session](session/end-session.md) command
+2. Start a new session: Use [@start-session](session/start-session.md) command
+
+The AI will generate and read status files in [status](status) to maintain project continuity.
+
+## Blueprints
+
+Blueprints are comprehensive guides for implementing specific technical architectures or project setups. They provide step-by-step instructions for installing, configuring, and integrating various technologies to create a functional foundation for your project.
+
+- [supabase-drizzle-actions.md](blueprints/supabase-drizzle-actions.md): Backend architecture with Supabase, Drizzle ORM, and Server Actions
+- [flux-with-replicate.md](blueprints/flux-with-replicate.md): Image generation using Flux and Replicate
+
+## Libraries
+
+- [lib](lib): Contains documentation examples for library usage
+
+## Plugins
+
+### v0
+
+- [v0.dev](https://v0.dev/) is a tool for generating React components from screenshots and chat. Currently, they don't have a Cursor plugin, so you can use [v0](v0/v0.md) bridging prompt.
+- [v0.md](v0/v0.md): Guide for using v0.dev to generate component ideas and prompts
+
 ## Contributing
 
 This is an open-source template. Contributions are welcome! Please add a changelog entry with your contribution.

blueprints/flux-with-replicate.md

@@ -0,0 +1,74 @@
+# Flux with Replicate Documentation
+
+Use this guide to setup generating images with Flux and Replicate.
+
+Write the complete code for every step. Do not get lazy. Write everything that is needed.
+
+Your goal is to completely finish the feature.
+
+## Helpful Links
+
+- [Replicate](https://replicate.com)
+- [Flux Schnell](https://replicate.com/black-forest-labs/flux-schnell?input=nodejs)
+
+## Required Environment Variables
+
+Make sure the user has the following environment variables set:
+
+- REPLICATE_API_TOKEN=
+
+## Install Replicate
+
+Make sure the user has the Replicate package installed:
+
+```bash
+npm install replicate
+```
+
+## Setup Steps
+
+### Create a Replicate Client
+
+This file should go in `/lib/replicate.ts`
+
+```ts
+import Replicate from "replicate";
+
+const replicate = new Replicate({
+  auth: process.env.REPLICATE_API_TOKEN,
+});
+```
+
+### Create a Server Action
+
+This file should go in `/actions/replicate-actions.ts`
+
+```ts
+"use server";
+
+import replicate from "@/lib/replicate";
+
+export async function generateFluxImage(prompt: string) {
+const input = {
+prompt: prompt,
+num_outputs: 1,
+aspect_ratio: "1:1",
+output_format: "webp",
+output_quality: 80
+};
+
+const output = await http://replicate.run("black-forest-labs/flux-schnell", { input });
+return output;
+}
+```
+
+### Build the Frontend
+
+This file should go in `/app/flux/page.tsx`.
+
+- Create a form that takes a prompt
+- Create a button that calls the server action
+- Have a nice ui for when the image is blank or loading
+- Display the image that is returned
+- Have a button to generate a new image
+- Have a button to download the image