INDEX.md

Documentation Index

Complete guide to all Voiden documentation.

🚀 Start Here

New to Voiden development?

1. Fresh Install Guide - Set up from scratch
2. Architecture Overview - Understand the system
3. Extension Development - Create your first extension

📂 Documentation Structure

Getting Started

Document	Description
Fresh Install	Complete setup for new repo clone
Development Workflow	Daily development guide
Quick Reference	Command cheatsheet

Architecture

Document	Description
Overview	System architecture and design
Core vs Extensions	Design philosophy
Request Engine	HTTP request system
Workspaces	Monorepo structure

Extensions

Document	Description
How to Add Extension	Complete guide to creating extensions
Extension Architecture	Extension system and types
Auto-Discovery	How manifest.json works
Submit Extension	Submit your extension to Voiden

Contributing

Document	Description
Contributing Guide	How to contribute, coding guidelines, and PR process

Customization

Document	Description
Creating Themes	How to create custom themes

Troubleshooting

Document	Description
Common Issues	FAQs and solutions
Build Errors	Build problems
Runtime Errors	App crashes/bugs

📝 Package Documentation

Core Packages

• SDK Package - Extension SDK details
• Core Extensions - Core extensions info

Module Documentation

• Request Engine - HTTP execution system

🔍 Finding Information

By Topic

Setup & Installation

• Fresh Install Guide
• Prerequisites (in Fresh Install)

Architecture & Design

• Architecture Overview
• Core vs Extensions Philosophy

Extension Development

• How to Add Extension
• External Plugin Guide (Planned)

Build & Deployment

• Build Order
• Production Build (in Fresh Install)

Troubleshooting

• Common Issues
• Build Errors (in Fresh Install)

By Role

New Developer

1. Fresh Install
2. Architecture Overview
3. Development Workflow

Extension Developer

1. Extension Guide
2. Extension Architecture
3. Submit Extension

Core Contributor

1. Architecture Overview
2. Core vs Extensions
3. Contributing Guidelines

🤝 Contributing to Docs

Docs need improvement? Please:

1. Check Contributing Guide
2. Submit PR with documentation updates
3. Follow markdown style guide

🔗 External Resources

• TipTap Docs: https://tiptap.dev/
• ProseMirror Guide: https://prosemirror.net/docs/guide/
• CodeMirror Docs: https://codemirror.net/docs/
• Electron Docs: https://www.electronjs.org/docs
• Vite Docs: https://vitejs.dev/

📞 Getting Help

1. Search docs in this folder
2. Search GitHub issues for similar problems
3. Create new issue with details

---

Last Updated: 2026-01-21 Maintainer: Voiden Team