CopilotKit / CopilotKit/outpost
README architecture/structure is out of date
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 7
- Forks
- 3
- Avg merge
- 7d 16h
- Merged PRs (30d)
- 15
Description
Problem
README.md no longer matches the repo.
Package paths wrong: README lists packages/ai, packages/db, packages/queue, packages/shared. Actual layout is nested: packages/outpost/{ai,db,queue,shared}.
Apps list incomplete: README's architecture + project-structure sections show 4 apps (web, discord-bot, github-app, docs). Repo actually has 10:
web, worker, discord-bot, discord-mcp, github-app, slack-bot, teams-bot, linear-sync, reddit-mcp, docs.
pgvector claim: README/architecture states "PostgreSQL 16 + pgvector", but schema.prisma declares no vector/embedding type and the extension isn't enabled. Either wire it up or correct the doc.
Expected
Update README architecture diagram, project structure, and the pgvector reference to reflect current reality.
Found during
Setup analysis (see PR #117).
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with README.md and compare its architecture diagram and project-structure sections with the listed current app and package paths. Check schema.prisma to verify the pgvector claim, then update the documentation to match the repository reality; done means all 10 apps, nested packages, and the PostgreSQL capability are represented accurately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- postgresql
- Domain
- databases, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100