Where to Find Palmier Pro Developer Documentation: Complete Guide

All Palmier Pro developer documentation lives inside the GitHub repository at palmier-io/palmier-pro, with the README, CONTRIBUTING guide, and AppTheme.swift serving as the primary entry points.

Palmier Pro is an open-source, Swift-native video editor for macOS 26+. Unlike external documentation sites, the project maintains all developer documentation within the repository itself, ensuring every file is version-controlled and synchronized with the codebase. This approach guarantees that the instructions you read match exactly the implementation you are building against.

Primary Documentation Entry Points

The repository contains several markdown files and Swift source files that constitute the official documentation.

README.md (Project Overview)

Start with the Root README at README.md for high-level project descriptions, build status badges, and links to supplementary resources. This file contains the project overview, download instructions, MCP server information, and an FAQ section covering licensing and platform support.

CONTRIBUTING.md (Development Setup)

The Contributing Guide at CONTRIBUTING.md provides step-by-step instructions for setting up a development environment, running the app locally, and executing the test suite. This is the essential starting point for new contributors who need to build the project from source.

Package.swift (Dependencies and Build Configuration)

Examine Package.swift to understand the Swift Package Manager configuration, including platform requirements (macOS 26+), Swift version specifications, and external dependencies. This manifest file defines the build targets and linking requirements for the entire project.

UI Development and Design System

All user interface components in Palmier Pro follow a strict design system defined in the source code.

AppTheme.swift Design System

The file Sources/PalmierPro/UI/AppTheme.swift serves as the single source of truth for styling. Developers must never hard-code numeric values for spacing, colors, fonts, or shadows. Instead, use the predefined constants from AppTheme.

For example, to create a button that respects the application's spacing and color palette:

import SwiftUI
import PalmierPro.UI

struct StyledButton: View {
    var title: String

    var body: some View {
        Text(title)
            .font(.system(size: AppTheme.FontSize.md, weight: .medium))
            .padding(AppTheme.Spacing.sm)
            .background(AppTheme.Background.raisedColor)
            .foregroundColor(AppTheme.Text.primaryColor)
            .cornerRadius(AppTheme.Radius.sm)
            .shadow(AppTheme.Shadow.md)
    }
}

The constants AppTheme.FontSize.md, AppTheme.Spacing.sm, and AppTheme.Background.raisedColor are defined in AppTheme.swift alongside other design tokens for colors, typography, and layout metrics.

Key Source Files for Developers

Beyond documentation files, the repository contains well-commented source code that serves as reference implementation:

• Sources/PalmierPro/Preview/TimelineRenderer.swift – Core rendering pipeline for the timeline view, handling video preview generation and frame management.

• Sources/PalmierPro/Export/ExportService.swift – Export logic supporting XML, text, and Lottie formats, demonstrating how the UI interacts with backend services.

• Tests/PalmierProTests/ – Comprehensive unit test suite covering UI components, timeline functionality, media handling, and export operations. These tests provide working examples of API usage.

Development Workflow

Clone the repository and build the application using standard Swift Package Manager commands:

# Clone the repository

git clone https://github.com/palmier-io/palmier-pro
cd palmier-pro

# Build the debug version

swift build

# Run the application

swift run

# Alternative: Launch with live OSLog streaming using the development script

./scripts/dev.sh

These commands are documented in the Getting Started section of CONTRIBUTING.md.

Additional Resources

The repository includes specialized documentation for specific use cases:

• Multilingual Documentation – Localized README files in Spanish, Chinese, Japanese, and other languages are available in the docs/readme/ directory (e.g., README.es.md).

• FAQ.md – Detailed answers regarding licensing, platform support, and the open-source scope, linked directly from the main README.

• MCP Server Documentation – Instructions for integrating external AI agents (Claude, Codex, Cursor) with the editor, describing how the Model Context Protocol server exposes editor functionality.

Summary

• Primary documentation is stored in README.md, CONTRIBUTING.md, and Package.swift at the repository root.
• UI styling standards are enforced through AppTheme.swift in Sources/PalmierPro/UI/, which provides the design system constants.
• Example code for building, testing, and UI development is available in the contributing guide and test suite.
• Version synchronization ensures documentation always matches the code since both are maintained in the same Git repository.

Frequently Asked Questions

Where is the official Palmier Pro developer documentation hosted?

All official documentation is hosted within the palmier-io/palmier-pro GitHub repository itself. There is no separate documentation website. The README, CONTRIBUTING guide, and inline source code comments serve as the complete documentation set, ensuring perfect alignment between docs and implementation.

How do I set up a local development environment for Palmier Pro?

Follow the instructions in CONTRIBUTING.md. You will need Xcode with Swift support for macOS 26+. Clone the repository, then run swift build and swift run to compile and launch the application. The scripts/dev.sh utility script is also available for launching with live OSLog streaming.

What is the AppTheme.swift file used for?

AppTheme.swift is the centralized design system file located at Sources/PalmierPro/UI/AppTheme.swift. It defines all constants for spacing, colors, fonts, shadows, and corner radii used throughout the application. Developers must use these constants instead of hard-coded values to maintain visual consistency across the macOS video editor.

Does Palmier Pro provide documentation for non-English speakers?

Yes. The repository includes multilingual documentation in the docs/readme/ directory, containing translations of the README in Spanish, Chinese, Japanese, and other languages. These files follow the naming convention README.{lang}.md (e.g., README.es.md for Spanish).

{
  "mcpServers": {
    "instagit": {
      "command": "npx",
      "args": ["-y", "instagit@latest"]
    }
  }
}