README.md

Vortex Documentation

Project and coding documentation. To set up and build Vortex, start with CONTRIBUTING.md. For code style, see CODESTYLE.md. Agents should also read AGENTS.md.

Start here

• repo-layout.md - Where everything lives, and where to start for a given change
• writing-documentation.md - Conventions for adding to these docs

Debugging

• DEBUGGING-GUIDE.md - VS Code debugging, log files, DevTools, Redux DevTools, performance
• error-reporting/ - How errors are captured, filtered, fingerprinted and exported

Writing code

• frontend.md - Renderer conventions: React, types, props, styling, icons, accessibility
• state.md - Renderer Redux state: the hives, writing and registering a reducer, verifiers, the deprecated storeHelper helpers
• testing.md - Running tests, component-test selectors, mocking vortex-api in extension tests
• design-system/page-migration.md - Converting a legacy MainPage to the new Page layout
• I18N_MIGRATION_GUIDE.md - Namespaces, key format, using t correctly
• I18N_STATUS.md - Migration progress by namespace
• game-art-assets.md - Where game logos and tiles come from, and what extensions should provide

Subsystems

• mod-management/collections.md - Collections and phased installation; phase invariants
• mod-management/EXTERNAL-CHANGES.md - The External Changes dialog: change types, actions, auto-resolution
• analytics.md - Mixpanel super properties, ID-to-name lookup tables, and how to add tracking to an extension
• updater.md - How updates are detected, downloaded and applied; install types, the state machine, channels and the analytics funnel
• updater-testing.md - Exercising the update cycle offline with the mock feed
• updater-rehearsal.md - Signed end-to-end rehearsal against a real GitHub repo

Building and shipping

• packaging/windows.md - Local unsigned installers, the pipeline, signed CI builds
• packaging/flatpak.md - Building and installing the Flatpak
• flatpak/technical.md - Flatpak manifest and runtime details
• flatpak/maintenance.md - Updating the Flatpak package
• branching-and-release-strategy.md - Master, release branches, what lands where
• cherry-pick-workflow.md - Automated cherry-picks between branches
• publishing-releases.md - What happens when a release goes out
• RELEASES.md - Which versions are supported, deprecation windows for vortex-api and the backend API, and how extension authors are notified

Installing from source

• install-instructions/ - Per-platform prerequisites, then the shared repository bootstrap: Windows · Arch · Debian · Fedora · NixOS · generic · shared setup

Research

These describe other products, as prior art. They are not documentation of Vortex itself.

• investigation/vscode.md - How VS Code's extension system works
• investigation/obsidian.md - How Obsidian's plugin system works