HackMD
Aframe Bot
Our friend Diego created Aframe, a framework for making 3D experiences in the web. He wants a documentation bot that lives in their Discord which is aware of all Aframe documentation.
This is a fairly open ended project in terms of specific deliverables: our goal is to make something that gives Aframe users real value and serves as a use case broadly for what we are doing with AI agents.
Research
Aframe - https://aframe.io/
Perplexity.ai - https://www.perplexity.ai/ - Like ChatGPT, but adds sources to responses
We're not using Perplexity but something along the lines of showing a link to the right documentation source would be useful
Cloudflare Discord bot - https://github.com/discord/cloudflare-sample-app
RAG Explanation: https://www.youtube.com/watch?v=u47GtXwePms
Storing OpenAI Embeddings with Postgres: https://supabase.com/blog/openai-embeddings-postgres-vector
Tech Stack
Cloudflare Workers - Our serverless deployment target
Supabase - Open source wrapper around Postgres for database, realtime messaging and storage
Postgres - We are using PGVector and custom functions for vector search
Discord.js - SDK for interacting with Discord
bgent - Our open source AI agent package
Requirements
- The bot will run on Discord 24/7
- The bot will need to perform RAG on the documentation to assist users with their code questions and help
- Users may request pointers to specific documentation or may want responses in the form of code
- The bot will need to check for change or updates to the documentation and update internally
- Since users will engage with the bot in public it will need to have some specific ability to make that a good Discord UX, like starting a thread and managing threaded conversations
- The bot will try to show the source of documentation used in retrieval, similar to Perplexity.ai
TODO
- Create mechanism for checking Aframe documentation and diffing regularly to update lore
- Think about how to modify bgent to present information with proper sourcing back to retrieved documents ("perplexity.ai trick")
Work Expectations
The project will be organized on Github using Github Issues and Github Projects.
We will coordinate here until we have decided on where it lives: https://github.com/lalalune/aframe-docs-bot
Milestones
Project planning meeting and team kickoff
Tuesday, February 19th
Prototype bot is working
Tuesday, February 26th
Review and Testing with Aframe Team
Tuesday, March 5th
Deployment
Friday, March 8th
Copy, credit, payment
This is an unpaid project. All code will be open source.
All developers will be credited appropriately on Github and on the bot itself. The Discord bot itself will say "created by" with credit to the contributors.
Anyone working on the project must contribute a minimum of 5 hours to be credited.
