Docs & polish: DocC hosting, examples, SECURITY.md, localization#14
Merged
Conversation
- 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
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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
onError:was added torecognizeSounds/classifyActivity, and added aPrototypeKitErrortopic.Docsworkflow (.github/workflows/docs.yml) builds the DocC archive viaxcodebuild docbuild, transforms it for static hosting, and deploys to GitHub Pages.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 newonErrorhandler. It lives outsideSources/, so it's reference code the package never compiles; copy it into an app.🔒 SECURITY.md
🌐 Localization
NSLocalizedStringwith anenstring table; setdefaultLocalization: "en"in the manifest. Ready for additional.lprojtranslations.Not done — needs your input
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
defaultLocalizationand the existing resources.en.lproj+Bundle.module) and thedocbuildstep are the parts most worth watching.🤖 Generated with Claude Code
Generated by Claude Code