oneie
Version:
Build apps, websites, and AI agents in English. Zero-interaction setup for AI agents (Claude Code, Cursor, Windsurf). Download to your computer, run in the cloud, deploy to the edge. Open source and free forever.
403 lines (286 loc) • 11.8 kB
Markdown
title: Readme Backend Cleanup
dimension: things
category: plans
tags: ai, backend, connections, convex, events, groups, knowledge, ontology, people, things
related_dimensions: connections, events, groups, knowledge, people
scope: global
created: 2025-11-03
updated: 2025-11-03
version: 1.0.0
ai_context: |
This document is part of the things dimension in the plans category.
Location: one/things/plans/readme-backend-cleanup.md
Purpose: Documents backend ontology conformance - complete assessment & plan
Related dimensions: connections, events, groups, knowledge, people
For AI agents: Read this to understand readme backend cleanup.
# Backend Ontology Conformance - Complete Assessment & Plan
**Status**: Assessment Complete ✅ | Ready for Execution 🚀
**Date**: 2025-10-25
**Total Assessment**: 1,562 lines of detailed planning across 4 documents
**Time to Execute**: 4-6 hours
**Risk Level**: Low (documentation only, no code changes)
## What This Is
A complete assessment and execution plan to reorganize the `/backend/` directory to 100% conform to the 6-dimension ontology. Currently, the backend has 20+ scattered markdown files with 7 duplicates. After this plan, it will be beautifully organized with all documentation mapped to groups, people, things, connections, events, and knowledge dimensions.
## The Four Documents (Read in This Order)
### 📋 Document 1: BACKEND-AUDIT-MANIFEST.md (`/backend/`)
**What**: File-by-file assessment of all 33 backend files
**Size**: ~500 lines
**Time to read**: 10-15 minutes
**Contains**:
- Current status of every file in `/backend/`
- Classification (keep, move, delete, consolidate)
- Duplicate detection and analysis
- Risk assessment for each action
- Directory structure review
**Read this first if you want to understand the current state in detail**
### 🎯 Document 2: backend-target-structure.md (THIS DIRECTORY)
**What**: Vision of what backend looks like after cleanup
**Size**: ~450 lines
**Time to read**: 15-20 minutes
**Contains**:
- Before/after directory structures (visual)
- Complete file mapping to 6 dimensions
- Where each dimension shows up in backend
- Quality metrics (before vs. after)
- Success checklist
- Why this matters (impact)
**Read this second to see the target and understand the benefits**
### ⚙️ Document 3: backend-ontology-conformance.md (THIS DIRECTORY)
**What**: Complete 100-cycle execution plan
**Size**: ~400 lines
**Time to read**: 20-30 minutes
**Contains**:
- Detailed classification matrix (all 33 files)
- 5 execution phases (Audit through Verification)
- 60+ cycle-based steps
- Phase-by-phase breakdown
- Timeline estimates
- Risk mitigation strategies
- Success criteria and commands
**Read this third to follow the step-by-step execution plan**
### ⚡ Document 4: backend-cleanup-quickstart.md (THIS DIRECTORY)
**What**: Quick reference for busy people
**Size**: ~350 lines
**Time to read**: 5-10 minutes
**Contains**:
- Quick summary tables
- Files to keep vs. move at a glance
- Exact commands to run
- 6-dimension mapping quick reference
- Risk mitigation summary
- Verification checklist
**Read this last (or first if you're in a hurry) for quick execution**
## The Problem (In 60 Seconds)
```
Current State (/backend/):
├── 20+ markdown files scattered in root
├── 7 duplicate files (3 query docs, 3 structure docs, 2 test reports)
├── Documentation mixed with source code
├── README.md says "4-table" (outdated)
├── Examples hidden in /backend/examples/
├── Obsolete _tests_disabled/ folder
└── No clear 6-dimension mapping
Result: Hard to navigate, confusing for new developers, duplicate info
```
## The Solution (In 60 Seconds)
```
Target State (/backend/):
├── convex/ (all source, untouched ✅)
├── lib/ (all utilities, untouched ✅)
├── test/ (all active tests, untouched ✅)
├── scripts/ (all build tools, untouched ✅)
├── README.md (updated to say "6-dimension")
├── LICENSE.md
└── package.json
/one/ (organized by dimension):
├── things/plans/backend-*.md (3 consolidated docs)
├── things/implementation/ (development guides)
├── connections/api/ (query reference)
├── events/ (test docs)
├── knowledge/examples/ (code examples)
└── people/ (auth roles)
Result: Beautiful, organized, discoverable, 100% ontology-compliant
```
## Key Actions
| Action | Count | Files | Effort |
| ---------------- | ----- | ------------------------------------------------------------------------------------------------------------------ | ------ |
| KEEP (no change) | 10 | convex/, lib/, test/, scripts/ | 0% |
| DELETE | 4 | ONTOLOGY-FILE-STRUCTURE.md, PERFECT-ONTOLOGY-STRUCTURE.md, ONTOLOGY-INTEGRATION-TEST-SUMMARY.md, \_tests_disabled/ | 5% |
| CONSOLIDATE | 7 | Merge 3→1, 3→1, 2→1 (query, structure, test docs) | 20% |
| MOVE | 12 | Documentation to /one/ (by dimension) | 30% |
| UPDATE | 1 | README.md (change "4-table" to "6-dimension") | 5% |
| VERIFY | All | TypeScript, links, schema | 40% |
## Quick Decision Matrix
### "I just want to understand the problem"
→ Read: BACKEND-AUDIT-MANIFEST.md (15 mins)
### "Show me the vision"
→ Read: backend-target-structure.md (20 mins)
### "How do I do this?"
→ Read: backend-ontology-conformance.md (30 mins)
### "Just tell me what to do"
→ Read: backend-cleanup-quickstart.md (10 mins)
### "I want to understand everything"
→ Read all 4 in order (60 mins total)
### "I want someone else to do this"
→ Share backend-ontology-conformance.md with agent-clean
## Success Criteria
After execution, you should have:
- ✅ All source code in `/backend/convex/` (unchanged)
- ✅ All utilities in `/backend/lib/` (unchanged)
- ✅ All active tests in `/backend/test/` (unchanged)
- ✅ All documentation in `/one/` (by dimension)
- ✅ Zero duplicate files (consolidated)
- ✅ Zero files in `/backend/` root except README, LICENSE
- ✅ TypeScript compiles without errors
- ✅ All markdown links valid
- ✅ Schema.ts verified - 6 dimensions intact
- ✅ README.md updated to say "6-dimension"
## Timeline
- **Phase 1 (Audit)**: Already done ✅
- **Phase 2 (Consolidation)**: ~1 hour
- **Phase 3 (Migration)**: ~2 hours
- **Phase 4 (Cleanup)**: ~1 hour
- **Phase 5 (Verification)**: ~1.5 hours
- **TOTAL**: 4-6 hours work
## Risk Assessment: LOW ✅
Why?
- ✅ Only reorganizing documentation
- ✅ Zero code changes
- ✅ Source code stays exactly where it is
- ✅ Schema.ts untouched
- ✅ Imports unchanged
- ✅ Tests remain active
- ✅ 100% reversible (git has everything)
What could go wrong?
- Broken markdown links (mitigated by grep search before moving)
- Lost documentation (mitigated by copy-first-delete-later)
- Missing targets (mitigated by creating directories first)
## What Gets Better
**Before**: "Where's the query documentation?"
- Answer: "QUERY_ONTOLOGY.md... or maybe QUERIES_ONTOLOGY_COMPLETE.md... or ONTOLOGY_QUERIES_EXAMPLE.md?"
- Problem: 3 files, unclear which to use
**After**: "Where's the query documentation?"
- Answer: "/one/connections/api/queries-reference.md"
- Solution: Single authoritative file, clear location
**Overall Benefits**:
- Faster discovery of documentation
- Easier onboarding for new developers
- Clear mapping to 6-dimension ontology
- No duplicate information
- Better organized by purpose
- Reduced cognitive load
## How to Proceed
### Path A: Thorough Understanding (Recommended)
```
1. Read BACKEND-AUDIT-MANIFEST.md (15 mins) - understand current state
2. Read backend-target-structure.md (20 mins) - see vision
3. Read backend-ontology-conformance.md (30 mins) - learn the plan
4. Execute phases 2-5 per the plan (4-5 hours)
5. Verify with checklist
6. Celebrate! 🎉
```
### Path B: Just Get It Done
```
1. Read backend-cleanup-quickstart.md (10 mins)
2. Run the commands listed
3. Verify TypeScript compiles
4. Done!
```
### Path C: Delegate
```
1. Share backend-ontology-conformance.md with agent-clean
2. Let agent-clean execute the plan
3. Review results
4. Approve and commit
```
## Commands to Execute (Quick Reference)
```bash
# Phase 2: Consolidate (1 hour)
# Merge 3 query docs → 1 queries-reference.md
# Merge 3 structure docs → 1 backend-structure.md
# Merge 2 test reports → 1 backend-integration-tests.md
# Phase 3: Move documentation (2 hours)
mkdir -p /one/things/implementation/
mkdir -p /one/connections/api/
mkdir -p /one/events/
mv /backend/BACKEND-STRUCTURE.md /one/things/plans/
mv /backend/IMPLEMENTATION-GUIDE.md /one/things/implementation/backend-guide.md
# ... (etc - see backend-cleanup-quickstart.md for full list)
# Phase 4: Clean up (1 hour)
rm -rf /backend/_tests_disabled/
rm /backend/ONTOLOGY-FILE-STRUCTURE.md
rm /backend/PERFECT-ONTOLOGY-STRUCTURE.md
# Phase 5: Verify (1.5 hours)
cd /backend && npx tsc --noEmit
grep -r "backend/" /one --include="*.md" | grep -v node_modules
ls -la /backend/*.md # Should be minimal
```
Full commands in backend-cleanup-quickstart.md
## FAQ
**Q: Will this break anything?**
A: No. Source code stays in /backend/convex/, imports unchanged, schema untouched.
**Q: How long does this take?**
A: 4-6 hours of focused work. Can be done in one day.
**Q: Can I undo it?**
A: Yes, 100% reversible. Git has all files.
**Q: Do I need to deploy?**
A: No. This is purely filesystem organization.
**Q: What if I don't like the result?**
A: Git reset. Everything is backed up.
**Q: Can someone else do this?**
A: Yes! Give backend-ontology-conformance.md to agent-clean.
**Q: Is this risky?**
A: Very low risk. Only moving documentation, not changing code.
## Next Steps
1. **Pick a reading path** (Thorough, Quick, or Delegate)
2. **Read the documents** in order
3. **Understand the plan** before executing
4. **Execute phase by phase** (or delegate to agent)
5. **Verify with checklist** after each phase
6. **Commit and celebrate** when done
## Files in This Assessment
Located in `/one/things/plans/`:
1. **readme-backend-cleanup.md** (this file - index)
2. **backend-ontology-conformance.md** (100-cycle plan)
3. **backend-target-structure.md** (vision document)
4. **backend-cleanup-quickstart.md** (quick reference)
Located in `/backend/`: 5. **BACKEND-AUDIT-MANIFEST.md** (file assessment)
## Summary
You now have everything needed to transform a messy 20-file backend root into a beautifully organized structure that 100% maps to the 6-dimension ontology. The plan is low-risk, well-documented, and reversible.
All you need to do is:
1. Pick a time to execute
2. Read the plan
3. Follow the steps
4. Enjoy a beautiful backend
**Status**: Ready for execution ✅
**Confidence Level**: High 🎯
**Effort Required**: 4-6 hours ⏱️
**Risk Level**: Low 🛡️
**Payoff**: Infinitely better developer experience forever 🚀
Let's make the backend beautiful!
_Assessment completed: 2025-10-25_
_Ready for execution: Now_
_Questions? Read the 4 documents above_