updated docs

b-rodrigues · b-rodrigues · commit 1df1b1996590 · 2025-12-08T15:40:52.000+01:00
diff --git a/docs/_nav.txt b/docs/_nav.txt
@@ -14,8 +14,8 @@ first-document|Your First Document
 
 SECTION: Features
 formatting|Text Formatting
-comments|Comments & Reviews
-timeline|Timeline & History
+comments|Comments and Reviews
+timeline|Timeline and History
 reconciliation|Reconciliation
 export|Export Options
 
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -34,17 +34,18 @@ Documentation lives in `docs/`:
 
 ### Write Code
 
-Ready to code? Start with issues labeled `good first issue`.
+LLM written code welcome!
 
 ---
 
 ## Development Setup
 
 ### Prerequisites
 
-- **Node.js 18+** and npm
-- **Rust 1.70+** (install via [rustup](https://rustup.rs))
-- System dependencies (see [Installation](installation.html))
+The repository ships with a Nix flake that provides the right tooling
+to hack on Korppi. The only prerequisite is Nix. If you don't use
+Nix (booooo) you need to set up the toolchain yourself. I won't provide
+any support for this.
 
 ### Clone & Install
 
@@ -53,22 +54,15 @@ Ready to code? Start with issues labeled `good first issue`.
 git clone https://github.com/b-rodrigues/korppi.git
 cd korppi
 
-# Install npm dependencies
-npm install
+# Drop into the development shell
+nix develop
 ```
 
 ### Run in Development
 
 ```bash
-# Start development server with hot reload
-npm run tauri dev
-```
-
-### Build for Production
-
-```bash
-# Create production build
-npm run tauri build
+# Start development server with hot reload (inside the nix shell)
+korppi-dev
 ```
 
 ---
@@ -158,13 +152,8 @@ Test these areas before submitting:
 
 ### Running Tests
 
-```bash
-# JavaScript tests (if any)
-npm test
-
-# Rust tests
-cd src-tauri && cargo test
-```
+Tests run on CI when you open a PR. It is of course obvious
+that a PR that breaks a test won't get merged.
 
 ---
 
diff --git a/docs/faq.md b/docs/faq.md
@@ -8,29 +8,38 @@ Common questions about Korppi.
 
 ### What is Korppi?
 
-Korppi is a markdown editor with built-in version history and reconciliation features. It's designed for writers who need to track changes, collaborate, and maintain document history.
+Korppi is a markdown editor with integrated version history and conflict-free
+merging. It lets you write, track changes, and collaborate asynchronously, all
+locally, with no dependence on third-party servers.
 
 ### Why "Korppi"?
 
-Korppi means "raven" in Finnish. Ravens are known for their intelligence and memory—fitting for an editor that remembers everything!
+Korppi means "raven" in Finnish. Ravens are known for their intelligence and
+memory—fitting for an editor that remembers everything!
 
 ### Is Korppi free?
 
-Yes! Korppi is free and open source software, released under the MIT license.
+Yes! Korppi is free and open source software, released under the GPLv3 license.
 
 ### What platforms does Korppi support?
 
-- **Linux** (AppImage, Debian package)
+- **Linux** (AppImage)
 - **macOS** (DMG)
-- **Windows** (MSI installer)
+- **Windows** (EXE and MSI installer)
+
+### Did you write Korppi?
+
+No, I designed Korppi, but Korppi was written 100% by LLMs!
 
 ---
 
 ## Documents
 
 ### What's a .kmd file?
 
-A `.kmd` (Korppi Markdown Document) file is Korppi's native format. It's a ZIP archive containing your markdown content, version history, comments, and metadata. See [File Format](file-format.html) for details.
+A `.kmd` (Korppi Markdown Document) file is Korppi's native format. It's a ZIP
+archive containing your markdown content, version history, comments, and
+metadata. See [File Format](file-format.html) for details.
 
 ### Can I open regular .md files?
 
@@ -48,55 +57,61 @@ Export your document:
 
 ### I accidentally closed without saving. Can I recover my work?
 
-If you had **Autosave** enabled, check the recent documents list—your last autosave should be there.
-
-If not, check for temporary files in your system's temp directory.
+If you didn't have autosave on, and if you ignored the prompt telling you that
+you had unsaved changes, too bad!
 
 ---
 
 ## Features
 
 ### How is this different from Git?
 
-Git is designed for code with line-based tracking. Korppi is designed for prose:
-
-- **Semantic patches** - Understands document structure
-- **Visual timeline** - No command line needed
-- **Comments** - Built-in review system
-- **Rich formatting** - Full markdown support
+Git manages code. Korppi manages writing. It provides non-technical
+collaborators with intuitive version history and automatic reconciliation so
+parallel edits can be merged into a clean, unified document.
 
 ### Can multiple people edit at once?
 
-Real-time collaboration is planned but not yet implemented. Currently, use the **Reconciliation** feature to merge changes from different authors.
+No. Korppi is not a live collaborative editor. Instead, it’s designed for
+asynchronous collaboration: the workflow where people exchange revised versions
+of a document, add comments, and make tracked changes independently. Korppi
+streamlines this process by providing built-in reconciliation, making it easy to
+merge these parallel edits into a single, coherent document.
 
 ### Do comments appear in exported files?
 
-- **Markdown export:** Comments are stripped (pure content only)
-- **DOCX export:** Comments as Word comments (coming soon)
+No. Korppi keeps comments and discussion inside the editor. The goal is to use
+Korppi for drafting, review, and revision. Once the content is finalized, you
+can export to Word and focus on formatting and layout there.
 
 ### Can I customize keyboard shortcuts?
 
-Not yet, but it's on the roadmap!
+No. Korppi is designed for business users who generally prefer consistent,
+preset shortcuts rather than custom configurations.
 
 ---
 
 ## Timeline & History
 
 ### How far back does the history go?
 
-Korppi saves your complete edit history within each `.kmd` file. There's no limit—all patches are preserved.
+Korppi saves your complete edit history within each `.kmd` file. There's no
+limit, all patches are preserved.
 
 ### Can I delete history?
 
-Currently, no. History is considered valuable data. A future release may add the option to compact history.
+Currently, no. History is considered valuable data. A future release may add the
+option to compact history.
 
 ### What's a "pending" patch?
 
-Pending patches are changes imported via reconciliation that haven't been reviewed yet. You can approve or reject them.
+Pending patches are changes imported via reconciliation that haven't been
+reviewed yet. You can approve or reject them.
 
 ### I restored an old version. Can I undo that?
 
-Use `Ctrl+Z` (Undo) immediately after restore, or reconcile with a backup of your newer version.
+Use `Ctrl+Z` (Undo) immediately after restore, or reconcile with a backup of
+your newer version.
 
 ---
 
diff --git a/docs/index.md b/docs/index.md
@@ -13,16 +13,29 @@
 
 ## What is Korppi?
 
-**Korppi** (Finnish for "raven") is a powerful desktop markdown editor built for writers, researchers, and technical authors who need more than just a text editor.
+**Korppi** (Finnish for "raven") is a powerful desktop markdown editor built for
+writers, researchers, and technical authors who need more than just a text
+editor.
 
-Unlike traditional editors, Korppi remembers **every change you make** and lets you travel through time to see how your document evolved!
+Unlike traditional editors, Korppi remembers **every change you make** and lets
+you travel through time to see how your document evolved!
+
+Korppi is a text editor that tries to focus on one problem, and one problem
+only: how to easily integrate changes from various collaborators into a main
+document. It is meant for business users that aren’t familiar with Git and use
+Microsoft Office’s *track changes* functionality for asynchronous collaboration.
+
+The idea is to first use Korppi to **just focus on the content** and gather
+feedback and input from coworkers. Then, use Korppi's user-friendly
+reconciliation features to merge all the input in the same document, **export to
+Word format** and continue with the layout there!
 
 <div class="feature-list">
 
 - **Timeline Tracking** - See every edit as a visual timeline
-- **Smart Reconciliation** - Import changes from other versions
+- **Smart Reconciliation** - Import changes from other versions, and easily handle conflicts
 - **Rich Formatting** - Full markdown with tables, code, images
-- **Comments & Reviews** - Collaborate with inline comments  
+- **Comments & Reviews** - Collaborate with inline comments
 - **Export Anywhere** - Markdown, Word DOCX, and more
 - **Autosave** - Never lose your work again
 
@@ -44,18 +57,16 @@ Unlike traditional editors, Korppi remembers **every change you make** and lets
 
 ## System Requirements
 
-- **Operating System:** Windows 10+, macOS 10.14+, or Linux (Ubuntu 20.04+)
-- **Memory:** 4GB RAM minimum
-- **Storage:** 100MB for application
+- **Operating System:** Windows, macOS, or Linux distributions (tested on Ubuntu 24.04+ and NixOS)
 
 ---
 
 ## What's New?
 
-### Version 0.1.0 (December 2024)
+### Version 0.1.999 (December 2025)
 
 - 🎉 Initial public release
-- ✏️ Full markdown editing with Milkdown
+- ✏️ Full markdown editing
 - 📊 Timeline with patch history
 - 💬 Comments and review system
 - 🔍 Find & Replace with regex support
diff --git a/docs/installation.md b/docs/installation.md
@@ -12,58 +12,43 @@
 
 1. Download the `.AppImage` file from the releases page
 2. Make it executable:
-   ```bash
-   chmod +x korppi_*.AppImage
-   ```
+
+```bash
+chmod +x korppi_*.AppImage
+```
+
 3. Run it:
-   ```bash
-   ./korppi_*.AppImage
-   ```
+
+```bash
+./korppi_*.AppImage
+```
 
 ### Option 2: Building from Source
 
 Requirements:
-- Node.js 18+ and npm
-- Rust 1.70+
-- System dependencies (see below)
+
+- Nix
 
 ```bash
 # Clone the repository
 git clone https://github.com/b-rodrigues/korppi.git
 cd korppi
 
-# Install dependencies
-npm install
+# Drop into the development shell
+nix develop
 
-# Run in development mode
-npm run tauri dev
+# Install Node.js dependencies
+npm install
 
-# Or build for production
-npm run tauri build
-```
+# Build an appimage
+npm run tauri build -- --bundles appimage
 
-#### Linux Dependencies
+# Build a deb (untested)
+npm run tauri build -- --bundles deb
 
-On Ubuntu/Debian:
-```bash
-sudo apt install libwebkit2gtk-4.1-dev \
-    build-essential \
-    curl \
-    wget \
-    file \
-    libssl-dev \
-    libayatana-appindicator3-dev \
-    librsvg2-dev
-```
-
-On Fedora:
-```bash
-sudo dnf install webkit2gtk4.1-devel \
-    openssl-devel \
-    curl \
-    wget \
-    file \
-    librsvg2-devel
+# Build an rpm (untested)
+# Note: On Debian/Ubuntu, you may need to install 'rpm' first: sudo apt install rpm
+npm run tauri build -- --bundles rpm
 ```
 
 ---
@@ -73,15 +58,20 @@ sudo dnf install webkit2gtk4.1-devel \
 1. Download the `.dmg` file from the releases page
 2. Open the DMG file
 3. Drag Korppi to your Applications folder
-4. Right-click and select "Open" (first time only, to bypass Gatekeeper)
+4. Because the app is not signed or notarized, macOS will block it the first time.
+   Open a terminal and run this command:
+   ```
+   xattr -cr /Applications/Korppi.app
+   ```
 
 ---
 
 ## Installing on Windows
 
-1. Download the `.msi` installer from the releases page
+1. Download the `.exe` installer from the releases page 
+   (unless you have an ARM device, download the `x86-setup.exe`)
 2. Run the installer
-3. Follow the installation wizard
+3. Follow the installation wizard (admin rights are **not required**)
 4. Launch Korppi from the Start menu
 
 ---
diff --git a/docs/quick-start.md b/docs/quick-start.md
diff --git a/docs/reconciliation.md b/docs/reconciliation.md
