docs: update sharing, download code, and App Store deploy for Apple r…#10
Merged
docs: update sharing, download code, and App Store deploy for Apple r…#10
Conversation
…estrictions - Sharing: replaced direct share link flow with Appsmith QR code workflow, noting that recipients need the Appsmith app installed to scan the QR code - Download Code: restricted to web only, updated steps to use the <> button with download link sent via email - Deploy to App Store: restricted to web only, commented out mobile submission steps
Collaborator
Code reviewFound 2 issues:
docs/getting-started/sharing-app.mdx Lines 8 to 16 in c2b9d02
docs/getting-started/sharing-app.mdx Lines 24 to 52 in c2b9d02 🤖 Generated with Claude Code - If this code review was useful, please react with 👍. Otherwise, react with 👎. |
…nk-sharing sections
Collaborator
|
LGTM |
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.
Note
Low Risk
Low risk documentation-only changes; main risk is user confusion if any outdated sharing instructions remain after commenting out the old link-based sections.
Overview
Updates the getting-started guides to reflect Apple restrictions: App Store deployment and code downloads are now documented as web-only, with prior mobile steps commented out and the App Store entry point corrected to the
Deploybutton.Reworks iOS sharing guidance to a QR-code flow from the web preview’s
On Mobilebutton, requiring recipients to installAppsmith - Vibecode Appsand scan the QR code; legacy direct-link sharing sections are commented out.Reviewed by Cursor Bugbot for commit 7e142d1. Bugbot is set up for automated code reviews on this repo. Configure here.
Greptile Summary
This PR updates three Getting Started docs to reflect Apple platform restrictions: App Store deployment and code download are restricted to web-only (with mobile steps commented out), and sharing is reworked to describe the Appsmith + QR code flow for iOS recipients.
deploy-app-store.mdx: Adds a web-only Note, comments out mobile submission steps, and corrects the UI button name from Share to Deploy — all accurate and clean.download-code.mdx: Adds a web-only Note and a new web download section using the<>button (link sent by email); mobile steps commented out — clean and complete.sharing-app.mdx: Adds iOS restriction Note and a new "How to Share Your App on iOS" Appsmith QR-code flow, but comments out all of the old link-based sharing documentation. Multiple other pages (deploying/overview.mdx,faqs.mdx,resources/glossary.mdx) still reference link-based sharing and direct users to this page — leaving web users with no sharing instructions.Confidence Score: 4/5
Safe to merge after addressing one P1 documentation gap in sharing-app.mdx — the other two files are clean.
Two of the three files are clean and well-structured. The sharing page has a P1 gap — link-based web sharing is referenced across the docs site but no longer documented on this page — which should be resolved before merging to avoid user confusion.
getting-started/sharing-app.mdx — needs either a restored web sharing section or explicit confirmation that link-based sharing has been fully retired across the product.
Important Files Changed
Flowchart
%%{init: {'theme': 'neutral'}}%% flowchart TD A[User wants to share Vibecode app] --> B{Recipient platform?} B -->|iOS recipient| C[Open project on Vibecode Web App] C --> D[Click 'On Mobile' button in preview] D --> E[QR code popup shown] E --> F[Share QR code with recipient] F --> G[Recipient downloads Appsmith app] G --> H[Recipient scans QR code] H --> I[App runs in Appsmith] B -->|Web / other| J[⚠️ No documentation — web sharing via link undocumented] style J fill:#f99,stroke:#c33Comments Outside Diff (4)
getting-started/sharing-app.mdx, line 25-32 (link)The new
<Note>at the top explicitly states that "direct share links are no longer available," but the "How Sharing Works" section still describes the old link-based flow in full:This directly contradicts the QR-code-only workflow added at the top of the page and will confuse users who read further. This section should either be removed or rewritten to describe QR-code sharing semantics.
Prompt To Fix With AI
getting-started/sharing-app.mdx, line 36-41 (link)This section still instructs users to "use the Share control" and says Vibecode will show:
These are features of the old direct-link flow. After the switch to QR codes, this section is outdated and misleading. It should be updated to describe where users can find the QR code in the UI, or removed.
Prompt To Fix With AI
getting-started/sharing-app.mdx, line 50-52 (link)The closing
<Note>block says:Since direct share links are explicitly removed per the top-of-page note, this statement is now inaccurate. It should be updated to reflect that sharing now works via QR code scanned through the Appsmith app.
Prompt To Fix With AI
getting-started/sharing-app.mdx, line 43-48 (link)The "Sharing Tips" section uses language that no longer applies to the QR code workflow:
These tips should be reworded to reflect the QR code approach (e.g., resharing the QR code screenshot, asking recipients to rescan after republishing, etc.).
Prompt To Fix With AI
Prompt To Fix All With AI
Reviews (3): Last reviewed commit: "docs: fix sharing doc to clarify iOS-onl..." | Re-trigger Greptile