Torrify Docs

Appearance

Torrify - Documentation Index ​

Last Updated: February 2026
Version: 0.9.2 (Pre-release)

Contact: For issues, complaints, suggestions, or feedback: hello@torrify.org

📖 How to Navigate This Documentation ​

We've created 20+ guides to help you understand, use, and extend Torrify. Here's how to navigate them:

🌟 Start Here (New Users) ​

1. START_HERE.md ⭐ READ FIRST ​

Purpose: Quick orientation and overview
Time: 5 minutes
You'll Learn:

  • What Torrify is
  • What works right now
  • How to get started
  • Where to find more info

Start with this file if you're new to the project.

🚀 Setup & Installation ​

2. QUICKSTART.md ⚡ SETUP GUIDE ​

Purpose: Get the app running in 5 minutes
Time: 5-10 minutes
Covers:

  • Prerequisites check
  • Installation steps
  • First test
  • Troubleshooting common issues
  • Command reference

Follow this to set up your environment.

3. README.md 📘 MAIN REFERENCE ​

Purpose: Complete application documentation
Time: 15-20 minutes
Covers:

  • All features in detail
  • Installation and usage
  • Configuration options
  • Development workflow
  • Building for production
  • Troubleshooting
  • Roadmap

Your go-to reference for everything.

🆕 What's New ​

4. WHATS_NEW.md 🎉 LATEST UPDATES ​

Purpose: Latest features and changes
Time: 5 minutes
Covers:

  • Streaming AI, image import, and recent feature updates
  • New features overview
  • How to use new features
  • Before/after comparisons
  • Quick examples

Read this to see what's changed since MVP.

5. SESSION_SUMMARY.md 📝 THIS SESSION ​

Purpose: Complete log of work done today
Time: 10 minutes
Covers:

  • All work done this session
  • Milestones achieved
  • Files created
  • Statistics
  • Next steps

Read this to understand what was built today.

🛠️ Technical Documentation ​

7. LLM_INTEGRATION.md 🤖 AI SYSTEM ​

Purpose: AI integration complete guide
Time: 15 minutes
Covers:

  • How AI works
  • Supported providers
  • Adding new providers
  • Configuration
  • API keys and security
  • Code examples
  • Troubleshooting

Read this to work with or extend the AI system.

7.5. CAD_BACKENDS.md 🔧 MULTI-BACKEND CAD ​

7.6. STREAMING_AI.md ⚡ STREAMING RESPONSES ​

Purpose: Streaming response behavior and controls
Time: 5 minutes
Covers:

  • Streaming UX
  • Stop/cancel behavior
  • Provider support

7.7. IMAGE_IMPORT.md 📷 IMAGE ATTACHMENTS ​

Purpose: Image inputs for AI chat
Time: 5 minutes
Covers:

  • Attaching images
  • Persistence in projects
  • Tips for best results

7.8. KNOWLEDGE_BASE.md 📚 CONTEXT MANAGEMENT ​

Purpose: API context system and updates
Time: 10 minutes
Covers:

  • Bundled context files
  • Update/reset flow
  • Context generation scripts

7.9. MENU_BAR.md 🧭 MENU & DIAGNOSIS ​

Purpose: Native menu + error diagnosis
Time: 5 minutes
Covers:

  • Menu structure
  • Menu-driven actions
  • One-click error diagnosis

8. SETTINGS_FEATURE.md ⚙️ SETTINGS DOCS ​

Purpose: Settings system documentation
Time: 10 minutes
Covers:

  • How settings work
  • Configuration options
  • Persistence mechanism
  • Path validation
  • Implementation details

Read this to understand or extend settings.

🧪 Testing ​

9. TESTING.md 🧬 TEST GUIDE ​

Purpose: Testing infrastructure and guide
Time: 15 minutes
Covers:

  • Running tests
  • Writing new tests
  • Test structure
  • Manual testing checklist
  • Coverage reporting
  • CI/CD examples

Read this before adding features or writing tests.

📋 Project Management ​

10. HANDOFF.md 🔄 COMPLETE LOG ​

Purpose: Complete development history
Time: 30 minutes
Covers:

  • Project motivation
  • All work phases
  • Every file created
  • All decisions made
  • Issues resolved
  • Complete timeline

Read this for complete project context.

🎯 Quick References ​

11. QUICK_REFERENCE.md ⚡ CHEAT SHEET ​

Purpose: One-page quick reference
Time: 2 minutes
Covers:

  • Common commands
  • Current status
  • File locations
  • Settings
  • Shortcuts
  • Quick troubleshooting

Bookmark this for quick lookups.

📚 Reading Paths ​

Path 1: Just Want to Use It (10 minutes) ​

1. START_HERE.md
2. QUICKSTART.md
3. WHATS_NEW.md
→ Done! Start coding

Path 2: Want to Develop It (45 minutes) ​

1. START_HERE.md
2. LLM_INTEGRATION.md
3. TESTING.md
4. HANDOFF.md
→ Ready to contribute

Path 3: Complete Understanding (90 minutes) ​

Read all 12 documents in order
→ Expert level knowledge

Path 4: Quick Lookup (2 minutes) ​

1. QUICK_REFERENCE.md
→ Find what you need

🔍 Find Information By Topic ​

About the Project ​

  • What it is: START_HERE.md
  • Why it exists: HANDOFF.md (intro)
  • Architecture: ARCHITECTURE.md, HANDOFF.md

Getting Started ​

  • Quick setup: QUICKSTART.md
  • First steps: START_HERE.md
  • Complete guide: README.md

Features ​

  • AI Chat: LLM_INTEGRATION.md
  • CAD Backends: CAD_BACKENDS.md (NEW!)
  • Settings: SETTINGS_FEATURE.md
  • Rendering: README.md, CAD_BACKENDS.md
  • Editor: README.md

Development ​

  • Testing: TESTING.md
  • Adding features: HANDOFF.md
  • Code structure: HANDOFF.md
  • History: SESSION_SUMMARY.md

Troubleshooting ​

  • Common issues: TROUBLESHOOTING.md (in getting-started)
  • AI problems: LLM_INTEGRATION.md
  • Build errors: README.md
  • Test failures: TESTING.md

📊 Document Statistics ​

Total Documentation:  12 main files + 2 reference files
Total Pages:          ~175 pages (if printed)
Total Words:          ~35,000 words
Average Read Time:    ~2.5 hours (all docs)
Quick Path:           ~10 minutes (essential docs)

For End Users ​

Day 1:
  Morning:   START_HERE.md + QUICKSTART.md
  Afternoon: Use the app, experiment
  Evening:   Read WHATS_NEW.md for AI features

Day 2:
  Morning:   README.md sections as needed
  Use:       Daily usage, explore features

For Developers ​

Day 1:
  Morning:   START_HERE.md → ARCHITECTURE.md
  Afternoon: LLM_INTEGRATION.md → TESTING.md
  Evening:   HANDOFF.md

Day 2:
  Morning:   Code exploration
  Afternoon: Run tests, make changes
  Evening:   Contribute features

🔖 Bookmark These ​

Most Useful:

  1. QUICK_REFERENCE.md - Daily use
  2. README.md - Complete reference
  3. LLM_INTEGRATION.md - AI work

For Development: 4. HANDOFF.md - Full context 5. TESTING.md - Before adding features 6. ARCHITECTURE.md - Architecture overview

💡 Tips ​

Finding Information Fast ​

Want to know how to...?

  • Use features → README.md
  • Add features → HANDOFF.md
  • Fix tests → TESTING.md
  • Configure AI → LLM_INTEGRATION.md
  • Change CAD backend → CAD_BACKENDS.md
  • Change settings → SETTINGS_FEATURE.md

Want to understand...?

  • Architecture → HANDOFF.md
  • AI system → LLM_INTEGRATION.md
  • Why decisions made → HANDOFF.md
  • What changed today → SESSION_SUMMARY.md

Just want to...?

  • Get started → START_HERE.md
  • Set it up → QUICKSTART.md
  • See what's new → WHATS_NEW.md
  • Quick lookup → QUICK_REFERENCE.md

📈 Documentation Quality ​

Coverage ​

  • ✅ Complete technical details
  • ✅ User guides
  • ✅ Developer guides
  • ✅ API references
  • ✅ Troubleshooting
  • ✅ Examples
  • ✅ Architecture
  • ✅ History

Style ​

  • Clear headings
  • Code examples
  • Step-by-step guides
  • Quick reference tables
  • Visual diagrams (ASCII)
  • Consistent formatting

🚀 Quick Actions ​

powershell
# Install everything
npm install

# Run the app
npm run electron:dev

# Test everything
npm test

# Read essentials
code START_HERE.md
code WHATS_NEW.md
code QUICK_REFERENCE.md

# Read for development
code HANDOFF.md
code LLM_INTEGRATION.md

📦 Complete File List ​

Documentation (core files) ​

  1. START_HERE.md
  2. QUICKSTART.md
  3. START_APP.md
  4. README.md (root)
  5. docs/README.md
  6. DEV_README.md
  7. TESTING.md
  8. HANDOFF.md
  9. LLM_INTEGRATION.md
  10. CAD_BACKENDS.md
  11. SETTINGS_FEATURE.md
  12. WHATS_NEW.md
  13. STREAMING_AI.md
  14. IMAGE_IMPORT.md
  15. KNOWLEDGE_BASE.md
  16. MENU_BAR.md
  17. SECURITY_AUDIT.md
  18. QUICK_REFERENCE.md
  19. NEXT_STEPS.md
  20. DOCUMENTATION_INDEX.md (this file)
  21. TROUBLESHOOTING.md (new!)

See docs/README.md for the full index and locations.

Plus:

  • (See history folder for logs)

✅ Verification ​

To verify you understand the documentation:

Basic Understanding:

  • [ ] Know what Torrify does
  • [ ] Know how to run it
  • [ ] Know what features exist
  • [ ] Know where to find help

Developer Understanding:

  • [ ] Know the architecture
  • [ ] Know how to add providers
  • [ ] Know how to run tests
  • [ ] Know how to contribute

🎯 Success Indicators ​

You're ready to use Torrify when:

  • ✅ You've read START_HERE.md
  • ✅ You've run QUICKSTART.md steps
  • ✅ The app launches successfully
  • ✅ You can render code (OpenSCAD or build123d)
  • ✅ You can chat with AI
  • ✅ You can switch between CAD backends

You're ready to develop Torrify when:

  • ✅ You've read HANDOFF.md
  • ✅ You understand HANDOFF.md
  • ✅ Tests pass on your machine
  • ✅ You can make changes and see results
  • ✅ You know where to find information

📞 Getting Help ​

If you're stuck:

  1. Check QUICK_REFERENCE.md
  2. Search relevant doc (README, etc.)
  3. Check troubleshooting sections
  4. Review code examples
  5. Run tests to see patterns

If features don't work:

  1. Check QUICKSTART.md troubleshooting
  2. Verify installation steps
  3. Check settings configuration
  4. Review error messages
  5. Check console (F12)

🎉 You're All Set! ​

With 20+ guides, you have everything you need to:

  • ✅ Use Torrify effectively
  • ✅ Work with multiple CAD backends (OpenSCAD, build123d)
  • ✅ Understand the architecture
  • ✅ Extend the features
  • ✅ Debug issues
  • ✅ Contribute improvements

Welcome to Torrify! 🚀

Documentation Index - February 2026

Released under the GPL-3.0 License.

Copyright © 2026 Torrify