Skip to content

Video: scaffolding for the MistKit story YouTube video (phase 1) - #493

Open
leogdion wants to merge 1 commit into
video/mistkit-storyfrom
video/mistkit-story-01-scaffolding
Open

leogdion wants to merge 1 commit into
video/mistkit-storyfrom
video/mistkit-story-01-scaffolding

Conversation

@leogdion

@leogdion leogdion commented Nov 2, 2026

Copy link
Copy Markdown
Member

Summary

Phase 1 of the YouTube video based on the talk "CloudKit as Your Backend: From iOS to Server-Side Swift" (Swift Craft / iOSDevUK 2026), which tells the story of MistKit and CloudKit Web Services.

This adds the folder structure and empty templates under Video/MistKitStory/. No script content is included yet; that gets written from the article, slides and transcript in later phases.

Branch model

  • video/mistkit-story is the base branch for the video project.
  • Each phase gets a video/mistkit-story-NN-<phase> branch that merges back into the base. This PR is phase 01.

What's included

  • sources/ has pointers to the CloudKitAsYourBackend article, the slides PDF (1.0.0-beta.5 release) and the example projects, plus a transcript/ drop folder.
  • outline/outline.md has a 10-chapter skeleton in article/slide order, with columns for source references.
  • script/ has one VO | Visual template per chapter (00 through 09).
  • shots/ has a shot list template and a B-roll checklist.
  • motion/ has the motion-graphics spec template and five stub specs (timeline, CKWS request flow, three layers, auth by database, field type polymorphism).
  • thumbnails/brief.md is the thumbnail brief.
  • youtube/ holds metadata (titles, description, links, tags) and chapter markers.

Only text files are tracked. A .gitignore in the folder keeps footage, audio, renders and NLE project files out of git. Nothing outside Video/ changes, so the Swift package build is unaffected.


Generated by Claude Code

Folder structure and empty templates under Video/MistKitStory/ for the
video based on the 'CloudKit as Your Backend' talk: sources, outline,
per-chapter script files, shot list, motion-graphics specs, thumbnail
brief and YouTube metadata. Media files are gitignored.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01V3TXo31WxJ8LsoiY3VbJT8
@coderabbitai

coderabbitai Bot commented Nov 2, 2026

Copy link
Copy Markdown

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: f0543ba7-27ea-4fb9-bdb4-c7c32dc3595f

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Use the checkbox below for a quick retry:

  • Trigger review
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@claude

claude Bot commented Nov 2, 2026

Copy link
Copy Markdown

Review: PR #493 (video scaffolding, phase 1)

This is a docs-only change under Video/MistKitStory/. It touches no Swift sources, so I found no build, security or performance impact.

What checks out

  • The relative links in sources/README.md to CloudKitAsYourBackend.md and iOSDevUKTalk.md resolve. Both files exist under Sources/MistKit/Documentation.docc/.
  • The .gitignore is sensible. It keeps media, NLE projects and renders out of git.
  • The ID conventions (chapter, shot and motion-spec IDs, status values) are documented in the README.

Suggestions (non-blocking)

  1. .gitignore gap: motion/project/ is described as holding project files, but only node_modules/ and out/ are ignored under it. Consider also ignoring common build artifacts (*.aep, *.mogrt, dist/, .cache/) if those will be used. Also consider *.srt and *.vtt under sources/transcript/ only if transcripts shouldn't be committed. The README says to drop them there, so as written they are tracked.
  2. CI cost: I found .github/workflows/MistKit.yml but did not check whether it has paths-ignore for Video/**. If it doesn't, every video-phase PR will run the full Swift matrix. Adding paths-ignore: ['Video/**'] would avoid that. This is worth confirming.
  3. Lint and header scripts: Scripts/lint.sh and header.sh target Swift sources, so they should be unaffected. A markdown linter, if you use one, may flag the 'TODO' placeholders.
  4. Repo placement: the video project lives inside the library repo and will grow with script and spec content. A separate repo or an orphan/long-lived branch might keep the library history cleaner. If you keep it here, the branch model described in the README (video/mistkit-story base) is reasonable.
  5. Placeholders: metadata.md and the recording rows in sources/README.md are all TODO. That is fine for a scaffold, but a tracking issue would stop them being forgotten.
  6. Test coverage: not applicable, because nothing in this PR is executable.

Overall this is clean and low risk, so I'd approve it once the CI path-filter question is settled.

🤖 Generated with Claude Code

@codecov

codecov Bot commented Nov 2, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
⚠️ Please upload report for BASE (video/mistkit-story@0c731a9). Learn more about missing BASE report.

Additional details and impacted files
@@                  Coverage Diff                   @@
##             video/mistkit-story     #493   +/-   ##
======================================================
  Coverage                       ?   85.25%           
======================================================
  Files                          ?      203           
  Lines                          ?     5244           
  Branches                       ?        0           
======================================================
  Hits                           ?     4471           
  Misses                         ?      773           
  Partials                       ?        0           
Flag Coverage Δ
spm 85.20% <ø> (?)
swift-6.3-noble 85.27% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants