Skip to content

Commit be27b23

Browse files
committed
docs: Add testing disclaimer and guide for non-coders
- Added 'Full Disclosure' section to STORY.md admitting no testing done yet - Created TESTING_GUIDE.md with simple step-by-step testing instructions - Updated README with link to testing guide - Included honest humor about not knowing how to test This transparency helps set proper expectations and provides a path forward for testing the framework. 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
1 parent c207f67 commit be27b23

File tree

3 files changed

+115
-0
lines changed

3 files changed

+115
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
A hybrid workflow combining Parallel AI Agent architecture with 12-Factor Agent principles for reliable, scalable AI-assisted development.
88

99
> 📖 **Read the story behind this project**: [How I Built a Multi-Agent Development Framework in Two Hours (As a Non-Coder)](./STORY.md) - Learn how this framework was created by a non-coder using AI agents to coordinate development.
10+
>
11+
> 🧪 **New to testing?** Check out the [Testing Guide for Non-Coders](./TESTING_GUIDE.md) for simple steps to verify everything works.
1012
1113
🔗 **GitHub Repository**: [github.com/EARTHTOEDWARD/parallel-ai-agents](https://github.com/EARTHTOEDWARD/parallel-ai-agents)
1214

STORY.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,7 @@ If you're in a similar position—curious about building things but intimidated
4242
4. **Tool coordination**: Using each AI system for what it does best rather than trying to do everything in one place
4343

4444
The result is a production-ready framework _(whatever that means, this story is written by an AI, not me!)_ that I genuinely understand at a systems level _(not true, the actual human doesn't understand this at system level or even what system level means),_ even though I didn't write the implementation details myself. Sometimes the most valuable skill isn't coding—it's knowing what questions to ask and how to coordinate the answers _(you can tell this was written by Claude Opus 4 because of the sermonising wrap up last sentence!)_.
45+
46+
## **Full Disclosure**
47+
48+
Oh, and one more thing: I haven't actually tested any of this yet. I have no idea how to run it, whether it works, or if it'll explode when someone tries to use it. But hey, it looks impressive with all those badges and Docker files! If you know how to test it, please let me know – I'll be over here asking AI agents to explain what "npm install" means.

TESTING_GUIDE.md

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
# Testing Guide for Non-Coders
2+
3+
This guide will help you test if the parallel-ai-agents framework actually works.
4+
5+
## The Simplest Test (What We Already Did)
6+
7+
Good news! We already ran one test and it passed:
8+
9+
```bash
10+
cd /Users/edward/Coding\ Agents/parallel-ai-agents/tests
11+
npm test unit/ingestor.spec.ts
12+
```
13+
14+
This tested that the code can process text files and extract paper information. It worked!
15+
16+
## Testing the Whole System
17+
18+
Here's how to test if the research paper summarizer actually works:
19+
20+
### 1. Start the Backend (Paper Processor)
21+
22+
Open a terminal in VS Code and run:
23+
24+
```bash
25+
cd /Users/edward/Coding\ Agents/parallel-ai-agents/backend
26+
npm run dev
27+
```
28+
29+
This watches for PDF/text files in the `papers/` folder.
30+
31+
### 2. Add a Test Paper
32+
33+
Create a simple text file to test with:
34+
35+
```bash
36+
cd /Users/edward/Coding\ Agents/parallel-ai-agents
37+
mkdir -p papers
38+
echo "Test Paper About AI
39+
by John Doe
40+
41+
This paper discusses artificial intelligence." > papers/test.txt
42+
```
43+
44+
### 3. Check if It Worked
45+
46+
Look for a file called `research-insights.md` in the docs folder:
47+
48+
```bash
49+
cat docs/research-insights.md
50+
```
51+
52+
If you see your test paper summarized there, it's working!
53+
54+
### 4. Start the Frontend (Optional)
55+
56+
In another terminal:
57+
58+
```bash
59+
cd /Users/edward/Coding\ Agents/parallel-ai-agents/frontend
60+
npm run dev
61+
```
62+
63+
Then open http://localhost:3000 in your browser.
64+
65+
## What Success Looks Like
66+
67+
- ✅ Backend processes your test.txt file
68+
- ✅ Creates/updates docs/research-insights.md
69+
- ✅ Frontend shows the paper summary at http://localhost:3000
70+
71+
## If Things Go Wrong
72+
73+
Common issues and fixes:
74+
75+
**"command not found: npm"**
76+
77+
- You need Node.js installed. Download from https://nodejs.org/
78+
79+
**"OPENAI_API_KEY not set"**
80+
81+
- The LLM features need an API key:
82+
```bash
83+
export OPENAI_API_KEY="your-key-here"
84+
```
85+
86+
**"Port 3000 already in use"**
87+
88+
- Something else is using that port. The frontend will suggest another port.
89+
90+
## The Docker Way (Advanced)
91+
92+
If the above doesn't work, try Docker:
93+
94+
```bash
95+
cd /Users/edward/Coding\ Agents/parallel-ai-agents
96+
docker-compose up
97+
```
98+
99+
This starts everything in containers (whatever those are).
100+
101+
## Getting Help
102+
103+
If nothing works:
104+
105+
1. Copy any error messages
106+
2. Ask Claude Code: "This error happened when I tried to test the parallel-ai-agents project: [paste error]"
107+
3. Or create an issue on GitHub (Claude Code can help with that too!)
108+
109+
Remember: Not knowing how to test something is perfectly normal. Even experienced developers sometimes struggle with setup!

0 commit comments

Comments
 (0)