DEV-1545: media dev docs — add V3 media guide (capture + upload)#286
Merged
Conversation
Adds docs/API/v3/media.md as the fliplet-media V3 catalog entry, teaching the cross-platform flow: Fliplet.Media.capture() (photo, web + native) → Fliplet.Media.Files.upload() → display via getContents()/authenticate(). Follows the barcode V3-doc pattern: the shared API/fliplet-media.md is set v3_relevant: false + exclude_from_v3_catalog: true so the V3 doc is the sole catalog entry (content rule — native-only Storage.* download API stays out of the AI's view). Regenerated .well-known indexes + v3/capabilities. Co-Authored-By: Claude <noreply@anthropic.com>
Deploying fliplet-cli with
|
| Latest commit: |
5fcb7fb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://a2bafa1c.fliplet-cli.pages.dev |
| Branch Preview URL: | https://feat-dev-1545-media-capture.fliplet-cli.pages.dev |
Reflect that capture() downscales (maxWidth/maxHeight default 2048) and re-encodes to WebP to minimize upload size; quality is WebP quality. Co-Authored-By: Claude <noreply@anthropic.com>
farhantariq12b
marked this pull request as ready for review
July 2, 2026 19:10
galisufyan-327
approved these changes
Jul 6, 2026
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
3 participants
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.
JIRA
https://weboo.atlassian.net/browse/DEV-1545
Summary
Adds
docs/API/v3/media.mdas thefliplet-mediaV3 catalog entry, teaching the cross-platform flow for V3 AI-built apps: capture a photo → upload → display.Fliplet.Media.capture()— take/pick a photo, web + native (paired with the api PR below)Fliplet.Media.Files.upload()— store any file (incl. attached audio/video) and get a URL backgetContents()(resize/convert) +Fliplet.Media.authenticate()(encrypted orgs)Follows the barcode V3-doc pattern (per
docs/CLAUDE.md"Dedicated V3 capability docs"):API/fliplet-media.mdsetv3_relevant: false+exclude_from_v3_catalog: true, with a pointer to the V3 guide.Storage.*"download to devices" API and internals (parseSFC/evalModule/PrivateFiles) stay out of the V3 doc so the builder never emits them.Files
docs/API/v3/media.md— the V3 guide + catalog frontmatterdocs/API/fliplet-media.md— excluded from V3 catalog + V3 pointer.well-known/*(llms.txt, llms-full.txt, llms-v3-libraries.json, agent-skills) +v3/capabilities.mdTesting
node bin/build-agent-indexes.mjs --strictgreen; catalog resolvesfliplet-media→API/v3/media.md, exactly 1 entry for the package (uniqueness holds).npm run test:unit— 163/163 pass. Cross-links resolve.Ship coupling
Do not merge/deploy ahead of the api PR that adds
Fliplet.Media.capture()— otherwise the doc advertises a method that isn't live yet. Studio'sfliplet-apis.jsonauto-regenerates from these docs post-merge (no studio change needed; camera preview permission already shipped by barcode #8634).🤖 Generated with Claude Code