README architecture/structure is out of date #119

Activity

1. NathanTarbert

   added

   documentationImprovements or additions to documentationImprovements or additions to documentation

   on Jul 20, 2026
2. copilotkit-outpost-bot commented on Jul 20, 2026

   

   copilotkit-outpost-botBot

   on Jul 20, 2026

   More actions

   🎫 Ticket TKT-KCVXWMJY created. Our AI assistant is reviewing your issue...
3. copilotkit-outpost-bot commented on Jul 20, 2026

   

   copilotkit-outpost-botBot

   on Jul 20, 2026

   More actions

   ⚠️ This is an AI-generated response and may be incomplete. We've escalated this to our engineering team — someone will follow up in this thread shortly.

   README Drift — This is a Docs/Repo Maintenance Issue, Not a CopilotKit Framework Question

   Hey! Just to set expectations: this looks like a bug report for a specific project's README (likely an open-source app built with CopilotKit), rather than a question about the CopilotKit framework itself. I'm the CopilotKit support assistant, so I can't directly edit your repo's README — but I can help you think through the fixes clearly.

   ---

   Here's What Needs to Change

   1. Fix Package Paths

   Code example (diff)

   - packages/ai
   - packages/db
   - packages/queue
   - packages/shared
   + packages/outpost/ai
   + packages/outpost/db
   + packages/outpost/queue
   + packages/outpost/shared

   2. Update the Apps List

   Replace the 4-app list with the full 10:

   ## Apps (`apps/`)
   
   | App | Description |
   |-----|-------------|
   | `web` | Main web application |
   | `worker` | Background job processor |
   | `discord-bot` | Discord integration |
   | `discord-mcp` | Discord MCP server |
   | `github-app` | GitHub App integration |
   | `slack-bot` | Slack integration |
   | `teams-bot` | Microsoft Teams integration |
   | `linear-sync` | Linear issue sync |
   | `reddit-mcp` | Reddit MCP server |
   | `docs` | Documentation site |

   3. Resolve the pgvector Claim

   You have two honest options — pick one:

   Option A — Remove the claim (if pgvector isn't used):

   Code example (diff)

   - PostgreSQL 16 + pgvector
   + PostgreSQL 16

   Option B — Wire it up (if embeddings are planned):

   Add to schema.prisma:

   // Enable pgvector extension
   generator client {
     provider        = "prisma-client-js"
     previewFeatures = ["postgresqlExtensions"]
   }
   
   datasource db {
     provider   = "postgresql"
     url        = env("DATABASE_URL")
     extensions = [vector]
   }
   
   // Example model with embedding
   model Document {
     id        String                 @id @default(cuid())
     content   String
     embedding Unsupported("vector(1536)")?
   }

   And in your migration:

   CREATE EXTENSION IF NOT EXISTS vector;

   ---

   Recommended Next Steps

   1. File this as a tracked issue in your repo (sounds like PR fix(dev): local pathfinder setup — bundled config, dedicated DB, OpenAI embeddings #117 already references it — link the issue there)
   2. Assign ownership — README drift is easy to fix but easy to ignore without an owner
   3. Consider adding a CI lint check to catch future drift, e.g., validating that all apps/* directories are documented

   ---

   If this is actually a CopilotKit repo issue, you can file it directly at github.com/CopilotKit/CopilotKit. Was this helpful?

   ---

   _{🤖 Generated by CopilotKit AI Support · Documentation}

   ---

   Was this helpful? React with 👍 or 👎
4. NathanTarbert

   added

   roadmapTracked on the Outpost roadmapTracked on the Outpost roadmap

   roadmap: laterRoadmap horizon: backlog / cleanupRoadmap horizon: backlog / cleanup

   area: docsDocs, README, .env accuracyDocs, README, .env accuracy

   on Aug 17, 2026
5. NathanTarbert

   added a commit that references this issue on Sep 18, 2026

   docs: refresh the README

   ...

   This issue will close once commit 97610bf is merged into the 'main' branch.

   97610bf