Skip to content

Docs & polish: DocC hosting, examples, SECURITY.md, localization#14

Merged
JamesDale merged 1 commit into
masterfrom
claude/docs-and-polish
Jul 2, 2026
Merged

Docs & polish: DocC hosting, examples, SECURITY.md, localization#14
JamesDale merged 1 commit into
masterfrom
claude/docs-and-polish

Conversation

@JamesDale

Copy link
Copy Markdown
Member

Summary

The documentation/polish bundle. Four of the five requested items are done; the fifth (relocating the README screenshots) needs the source image files, which this environment can't fetch — details below.

What's included

📖 Hosted DocC

  • Enriched the catalog landing page, fixed the symbol links that broke when onError: was added to recognizeSounds/classifyActivity, and added a PrototypeKitError topic.
  • New Docs workflow (.github/workflows/docs.yml) builds the DocC archive via xcodebuild docbuild, transforms it for static hosting, and deploys to GitHub Pages.
  • One-time setup required: Settings → Pages → Build and deployment → Source → GitHub Actions. Then it serves at https://fridaytechnologies.github.io/PrototypeKit/documentation/prototypekit.

🧩 Sample app

  • Examples/ gallery (PrototypeKitExamples.swift + README) demonstrating every feature — camera/Vision, Core ML, sound, motion, and Natural Language — including the new onError handler. It lives outside Sources/, so it's reference code the package never compiles; copy it into an app.

🔒 SECURITY.md

  • Vulnerability-reporting policy pointing at GitHub private advisories.

🌐 Localization

  • The two user-facing camera placeholder messages now go through NSLocalizedString with an en string table; set defaultLocalization: "en" in the manifest. Ready for additional .lproj translations.

Not done — needs your input

  • README screenshots. The four setup images use rot-prone github.com/.../assets/… attachment URLs. Relocating them means committing the actual image files, but they return 403 through this environment's proxy, so I can't fetch them. If you drop the images into a repo folder (e.g. Documentation/Images/), I'll rewire the README to reference the committed copies.

Notes for reviewers

  • Source-compatible; the only manifest changes are defaultLocalization and the existing resources.
  • Authored without a local Swift toolchain, so CI here is the first machine build — the localization resource wiring (en.lproj + Bundle.module) and the docbuild step are the parts most worth watching.

🤖 Generated with Claude Code


Generated by Claude Code

- DocC: enrich the catalog landing page, fix symbol links for the new onError
  signatures, add a PrototypeKitError topic, and add a Docs workflow that builds
  the DocC archive and publishes it to GitHub Pages (one-time: set Pages source
  to "GitHub Actions").
- Examples: add an Examples/ gallery (reference SwiftUI, not built by the package)
  demonstrating every feature, including the onError handler, plus a README.
- SECURITY.md: vulnerability-reporting policy.
- Localization: route the two user-facing camera placeholder messages through
  NSLocalizedString with an en string table, and set defaultLocalization: "en".
- README: link the hosted docs and the Examples gallery.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_014wwQvH5kuGmjQ9nW3gJ6zD
@JamesDale
JamesDale merged commit 79566d1 into master Jul 2, 2026
4 checks passed
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