Skip to content

Open source CapCut alternative.

TypeScript
3.9 KB
Raw Blame

Donkey Docs

This folder is the product and engineering source of truth for capabilities that are already supported.

Donkey is a video editor. Donkey Cut runs in the browser; the Mac app is a menu bar app that lets that page use the Mac's hardware — the local Donkey Cut engine for encoding, storage, and speech-to-text, plus screen recording.

Guides

Supported product and engineering guides live in docs/guides/. This list is the canonical index — keep it in sync when you add or rename a guide.

The product

  • Donkey Cut — the video editor: what runs in the browser, what runs on the Mac, and the local resources behind it.

  • Donkey Cut's AI Assistant — how a chat turn runs: the providers, the tool bridge, what the model knows, and the context budgets.

  • Brief to Video — the director pipeline: story planning and the identity ladder that keeps a cast consistent.

  • Local Compute — why a project the engine doesn't store still uses the Mac, and the rule that keeps its data where it lives.

  • Color — one recipe per clip, and HDR delivery.

  • Performance — the frame budget, the four ways we keep the main thread clear, the memory budget, and how a change is measured before it ships.

  • ChatGPT App — account linking, cloud project previews, and the boundary between the ChatGPT client and shared playback.

Site and backend

  • Backend API Guide — the hosted routes the app and site call for model-backed work.
  • Frontend and Next.js Guidelines — route structure, server/client boundaries, styling, and data access in the site app.
  • The Blog — the posts on donkeycut.com/blog: where a post lives, and how it reaches the page through the cache.
  • Backlit Icon — the dark treatment that lights the donkey mark from behind: the layer stack, the tokens, and the rules that keep the mark clean.

Operations

  • The iOS App — the phone app's structure, building and testing it, sign-in configuration, and the TestFlight path.
  • Install Donkey Locally — building the app bundle and disk image for local testing.
  • Releasing Donkey — how production releases are built and shipped, including the tools that ship inside the app.

Working in this repo

  • Swift Guide — the MVC split, language defaults, concurrency, SwiftUI, Mac platform behavior, data, and tests for the iOS and Mac apps.
  • Code Review Guide — what makes a change reviewable, and how we review.
  • Writing Style — the style every piece of writing follows: documentation, marketing, and everything else.
  • Engineering Doc Style Guide — the required structure, sentence-level rules, and post-writing test for every doc here.

Add or update an entry here when behavior becomes supported. Don't duplicate this index in subdirectories or app folders; link directly between related docs only when the relationship helps a maintainer. Follow the Writing Style guide, and structure docs following the Engineering Doc Style Guide.

Navigation Rules

  • Product guides should explain supported behavior, boundaries, and verification.
  • Engineering guides should explain patterns current code must follow, not speculative architecture.
  • Guides should not duplicate implementation. Prefer intent, rules, and concise source entrypoints over code listings or long file inventories.
  • Register a new guide once, in the Guides index above; beyond that prefer one canonical file in docs/ and selective cross-links only where they carry context.