Documentation

Guides for
working with Toucan.

Everything lives on this site. Source files, samples and the issue tracker are on GitHub.

Using Toucan

Settings and features you meet in the app.

AI IntegrationThe app-wide AI switch, AI services (Claude, OpenAI-compatible, Gemini), the open and editable prompts of Translate, Analyze and Clarity, the secret store, and the migration from the old LLM providers.Format support matrixWhich file formats Toucan edits safely, what survives a save, and what does not.Provider Settings (App-level and Project-level)Where provider settings and keys live (keys in the secret store), built-in provider defaults (Google, DeepL, Microsoft, AI, Custom), encryption model and the settings dialog.Pretranslation — Preview & ProgressHow pre-translation previews, reports progress, cancels and commits with Apply Preview; includes a provider privacy note.

Extending Toucan

How it is built, and how to add formats, providers and rules.

Writing Toucan pluginsPlugin author guide: manifest, formats, providers, rules, framework profiles, trust model, testing. Preview since v0.18.0; Avalonia app and CLI only.Toucan architectureCurrent project boundaries, host composition, desktop state, project persistence, plugins, and AI integration, with implementation links and Mermaid diagrams.Toucan.Core interop architectureCurrent translation model, format strategy contracts, manifest loading, save integration, and Core/module boundaries. Links to the application architecture and extension guides.

Project status

What works, what is broken and what comes next.

Toucan roadmap: v0.21 to v1.0Eleven focused releases from v0.21 to v0.31: file safety, extension platform, editing, terminology, review, snapshot and CRUD sources, one online connector, distribution, and measured stabilization.Known Issues & Unfinished FeaturesOpen issues for v0.22.0: no tracked format bugs (limits per format are in formats.md), release gaps, missing panels, and verification limits. Fixed bugs live in CHANGELOG.md.Shipped FeaturesChecklist of shipped features as of v0.22.0 (AI Integration added), grouped by area. Only shipped items are listed; open work is in the roadmap and bugs in known-bugs.md.

Design

Brand rules and how the UI is reviewed.

Toucan: Brand GuidelinesBrand guidelines: name, voice, colors, logo use. Platform line updated for v0.22.0 (Avalonia on all platforms).Visual review: screenshots of every screenHow to render PNGs of every screen headlessly with TOUCAN_TEST_SCREENSHOTS, what each file shows and the known limits.

Also on the site

Release history and the project on GitHub.

ChangelogEvery documented release, searchable.Build from source ↗Clone, build and run Toucan yourself. On GitHub.