47 lines (33 loc) · 1.69 KB

Documentation Index

This repository uses topic-based documentation under docs/.

User

Installation & updates: user/AUTO_UPDATE.md
Getting started / help: user/HELP.md
Troubleshooting: user/TROUBLESHOOTING.md

Testing

Testing guide: testing/TESTING.md

Features

Zoom: features/ZOOM.md
Images (paths/Base64/behavior): features/IMAGES.md

Performance

Baseline + roadmap + plan: performance/PERFORMANCE.md

Development

Architecture: dev/ARCHITECTURE.md
Development guide: dev/DEVELOPMENT.md
Renderer roadmap: dev/renderer/RENDERER_MARKDOWN_IT_PLUGIN_ROADMAP.md

Release

Release process: release/RELEASE_PROCESS.md
Release workflow design: release/RELEASE_WORKFLOW_DESIGN.md

Design

Host app browser design: design/DESIGN_HOST_APP_BROWSER.md

Debug

Debug docs: debug/
Quick index: debug/README.md

Research

Competitive analysis: research/COMPETITIVE_ANALYSIS.md

Legal

Third-party licenses: licenses/THIRD_PARTY_LICENSES.md

History (Archived)

Older docs retained for reference: history/

Featured lessons

Sparkle auto-update lessons learned: history/lessons/LESSONS_SPARKLE_AUTO_UPDATE.md