-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Description
As a stakeholder (or future maintainer), I want clear project documentation so that I can understand, run, and evaluate the system without tribal knowledge.
Acceptance Criteria:
- Repository contains a complete and up-to-date README.md
- A new contributor can:
- Understand what the system does
- Set it up locally or on EC2
- Run the chat UI and MCP integration - Documentation reflects the current achitecture, not past assumptions (if any)
- Demo steps are clearly documented
Technical Tasks:
-
README Content
- Write high-level project overview and goals
- Document system architecture (UI -> MCP -> Tools)
- Describe agentic behavior and dynamic skills concept
- List major technologies used (React/Next., MCP, etc)
-
Setup and Usage
- Document prerequisites (Node versions, env vars, EC2 assumptions)
- Add setup instructions for frontend
- Document how the UI connects to the MCP server
- Include example .env configuration (no secrets)
-
Demo & Evaluation
- Add step-by-step scripted demo instructions
- Document expected outputs and tool behavior
- Include screenshots or ASCII diagrams (which honestly are optional but would be kinda cool)
-
Maintenance Notes
- Explain how to add new skills via /skills
- Document known limitations or future work
- Add troubleshooting section for common issues.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels