Trimmed Writing for OpenFCPXMLKit

[IAmVigneswaran]

@latenitefilms I have trimmed the writing for OpenFCPXMLKit and also added SwiftFCPXML.

Thanks!

---

Summary by cubic

Trimmed and simplified the OpenFCPXMLKit docs for clarity and consistency, consolidating feature bullets and removing redundant notices. Added a new SwiftFCPXML section in developer docs with a brief overview and link.

^{Written for commit 618397a. Summary will update on new commits.}

[cubic-dev-ai]

3 issues found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="docs/_includes/tools/openfcpxmlkit.md">

<violation number="1" location="docs/_includes/tools/openfcpxmlkit.md:5">
P3: Readers may infer that XLKit is also the PDF backend, but PDF export uses CoreGraphics. Separating the Excel/XLKit and PDF capabilities would keep the integration description accurate.</violation>

<violation number="2" location="docs/_includes/tools/openfcpxmlkit.md:5">
P2: Calling the project merely “experimental” drops the concrete warning that production workflows and report generation are not extensively tested and that the API may change without notice. Because this page advertises reporting and a broad API, retaining a concise production/API-stability warning would reduce the risk of readers treating it as production-ready.</violation>

<violation number="3" location="docs/_includes/tools/openfcpxmlkit.md:9">
P2: On iOS, this bullet overstates validation support: full DTD validation is macOS-only and iOS falls back to structural validation. Keeping the platform qualifier here would prevent iOS users from expecting schema/DTD validation.</violation>
</file>

<sub>Reply with feedback, questions, or to request a fix.

Re-trigger cubic</sub>

[cubic-dev-ai]

P2: Calling the project merely “experimental” drops the concrete warning that production workflows and report generation are not extensively tested and that the API may change without notice. Because this page advertises reporting and a broad API, retaining a concise production/API-stability warning would reduce the risk of readers treating it as production-ready.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At docs/_includes/tools/openfcpxmlkit.md, line 5:

<comment>Calling the project merely “experimental” drops the concrete warning that production workflows and report generation are not extensively tested and that the API may change without notice. Because this page advertises reporting and a broad API, retaining a concise production/API-stability warning would reduce the risk of readers treating it as production-ready.</comment>

<file context>
@@ -2,36 +2,20 @@
-
-> [!NOTE]
-> This project is shared as is and is not under active or regular development.
+**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, and [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel/PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is currently experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion.
 
 #### Core Features
</file context>

Suggested change

**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, and [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel/PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is currently experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion.

**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, and [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel/PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion; production workflows and report generation are not extensively tested, and the API may change without notice.

[cubic-dev-ai]

P2: On iOS, this bullet overstates validation support: full DTD validation is macOS-only and iOS falls back to structural validation. Keeping the platform qualifier here would prevent iOS users from expecting schema/DTD validation.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At docs/_includes/tools/openfcpxmlkit.md, line 9:

<comment>On iOS, this bullet overstates validation support: full DTD validation is macOS-only and iOS falls back to structural validation. Keeping the platform qualifier here would prevent iOS users from expecting schema/DTD validation.</comment>

<file context>
@@ -2,36 +2,20 @@
-- **Excel Reporting**: Production's Best Friend–style multi-sheet `.xlsx` workbooks from an FCPXML/FCPXMLD via `FinalCutPro.FCPXML.buildReport(options:)` (XLKit-backed). Sheets for Role Inventory (Selected Roles + per-role), Markers, Keywords, Titles & Generators, Transitions, Video & Audio Effects, Speed Change Effects, and a Summary sheet with per-role duration totals and percentages; role exclusions, project-name filtering, and progress callbacks.
-- **CLI**: `OpenFCPXMLKit-CLI` with `--check-version`, `--convert-version`, `--validate`, `--media-copy`, `--create-project` (new empty FCPXML project with width/height/rate/version), `--report` (Excel report; `--report-full` and per-section flags), logging options (see CLI README).
-- **Architecture**: Protocol-oriented, dependency-injected; sync/async APIs; Swift 6 concurrency-safe design; comprehensive test suite with file-based and logic tests.
+- **Documents & validation** – Read, create, and modify `.fcpxml`/`.fcpxmld` files with support for FCPXML 1.5–1.14, semantic and DTD validation, version conversion, and cut detection
+- **Timecode & timing** – SwiftTimecode integration with `CMTime`, arithmetic, frame alignment, and support for common frame rates
+- **Typed models** – Resources, events, clips, projects, transitions, multicam, adjustments, filters, captions, keyframe animation, and more
</file context>

Suggested change

	- **Documents & validation** – Read, create, and modify `.fcpxml`/`.fcpxmld` files with support for FCPXML 1.5–1.14, semantic and DTD validation, version conversion, and cut detection
	- **Documents & validation** – Read, create, and modify `.fcpxml`/`.fcpxmld` files with support for FCPXML 1.5–1.14, semantic and DTD validation on macOS (structural validation on iOS), version conversion, and cut detection

[cubic-dev-ai]

P3: Readers may infer that XLKit is also the PDF backend, but PDF export uses CoreGraphics. Separating the Excel/XLKit and PDF capabilities would keep the integration description accurate.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At docs/_includes/tools/openfcpxmlkit.md, line 5:

<comment>Readers may infer that XLKit is also the PDF backend, but PDF export uses CoreGraphics. Separating the Excel/XLKit and PDF capabilities would keep the integration description accurate.</comment>

<file context>
@@ -2,36 +2,20 @@
-
-> [!NOTE]
-> This project is shared as is and is not under active or regular development.
+**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, and [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel/PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is currently experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion.
 
 #### Core Features
</file context>

Suggested change

**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, and [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel/PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is currently experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion.

**OpenFCPXMLKit** is a modern Swift 6 framework for working with Final Cut Pro's FCPXML, offering full concurrency support, SwiftTimecode integration, [XLKit](https://github.com/TheAcharya/XLKit) integration for Excel reporting, and PDF reporting. It provides a type-safe API for parsing, creating, and manipulating FCPXML using async/await, and targets macOS 26+ and iOS 26+. The project is currently experimental, developed using AI agents, and covers most core FCPXML attributes with room for future expansion.