From 50df4fc28348564d404c8c56618eca13a6985727 Mon Sep 17 00:00:00 2001 From: Rikas Date: Fri, 27 Feb 2026 03:34:55 +0530 Subject: [PATCH 1/3] chore: Consolidate and rewrite documentation --- custom-gpt.mdx | 2 - docs.json | 156 ++++----------- faq/app-ideas.mdx | 18 -- faq/building-tips.mdx | 20 -- faq/data-integrations.mdx | 20 -- faq/getting-started.mdx | 22 -- faq/tips-tricks.mdx | 18 -- faqs.mdx | 16 +- features/sound-generation.mdx | 2 - features/vibecode-cloud.mdx | 41 +++- getting-started/home-screen-widgets.mdx | 2 - getting-started/integrations.mdx | 29 ++- getting-started/pinch-to-build.mdx | 37 +++- getting-started/plans-and-credits.mdx | 133 +++++++----- getting-started/sharing-app.mdx | 36 +++- getting-started/use-case-1.mdx | 2 - getting-started/use-case-2.mdx | 2 - getting-started/web-to-mobile.mdx | 2 - google-login/code-reference.mdx | 157 --------------- google-login/implementation.mdx | 246 ----------------------- google-login/setup-guide.mdx | 256 ------------------------ google-login/setup.mdx | 5 +- index.mdx | 58 +++--- resources/community.mdx | 2 - resources/glossary.mdx | 2 - support.mdx | 2 - 26 files changed, 292 insertions(+), 994 deletions(-) delete mode 100644 faq/app-ideas.mdx delete mode 100644 faq/building-tips.mdx delete mode 100644 faq/data-integrations.mdx delete mode 100644 faq/getting-started.mdx delete mode 100644 faq/tips-tricks.mdx delete mode 100644 google-login/code-reference.mdx delete mode 100644 google-login/implementation.mdx delete mode 100644 google-login/setup-guide.mdx diff --git a/custom-gpt.mdx b/custom-gpt.mdx index 772d03d..6fd7453 100644 --- a/custom-gpt.mdx +++ b/custom-gpt.mdx @@ -3,8 +3,6 @@ title: "App Idea Generator" description: "Use our Custom GPT to brainstorm and refine your app idea" --- -# App Idea Generator - ## Vibecode Custom GPT Struggling to articulate your app idea? Our custom GPT is designed to help you clarify and refine your vision. diff --git a/docs.json b/docs.json index 7d538fd..1674435 100644 --- a/docs.json +++ b/docs.json @@ -14,109 +14,45 @@ "tab": "Getting Started", "groups": [ { - "group": "Introduction", - "pages": [ - "index", - "getting-started/plans-and-credits", - "getting-started/creating-first-app", - "getting-started/claude-code", - "getting-started/web-app" - ] + "group": "Welcome", + "pages": ["index", "quickstart", "getting-started/plans-and-credits"] }, { - "group": "Sharing & Publishing", - "pages": [ - "getting-started/sharing-app", - "getting-started/home-screen-widgets", - "getting-started/deploy-app-store" - ] + "group": "Your First App", + "pages": ["getting-started/creating-first-app", "getting-started/claude-code", "getting-started/web-app"] }, { "group": "Vibecode Tools", - "pages": [ - "getting-started/pinch-to-build", - "getting-started/export-ssh", - "getting-started/download-code", - "getting-started/integrations" - ] + "pages": ["getting-started/pinch-to-build", "getting-started/export-ssh", "getting-started/download-code", "getting-started/integrations"] }, { "group": "Prompting Tips", - "pages": [ - "getting-started/web-to-mobile", - "getting-started/native-ui-components" - ] + "pages": ["getting-started/web-to-mobile", "getting-started/native-ui-components"] }, { "group": "Use Cases", - "pages": [ - "getting-started/use-case-1", - "getting-started/use-case-2" - ] + "pages": ["getting-started/use-case-1", "getting-started/use-case-2"] } ] }, { - "tab": "Backend & Features", + "tab": "Features", "groups": [ { "group": "Backend & Data", - "pages": [ - "features/backend-auth", - "features/api-integrations", - "features/vibecode-cloud" - ] + "pages": ["features/backend-auth", "features/vibecode-cloud", "features/api-integrations"] }, { - "group": "App Capabilities", - "pages": [ - "features/haptics", - "features/sound-generation", - "features/image-generation" - ] - } - ] - }, - { - "tab": "Payments", - "groups": [ - { - "group": "Payments", - "pages": [ - "payments/revenuecat-setup", - "payments/stripe-setup" - ] - } - ] - }, - { - "tab": "Google Login", - "groups": [ - { - "group": "Google Sign-In (Better Auth)", - "pages": [ - "google-login/setup" - ] - } - ] - }, - { - "tab": "Deploying", - "groups": [ + "group": "Authentication", + "pages": ["google-login/setup"] + }, { - "group": "Web Apps", - "pages": [ - "deploying/guide", - "deploying/custom-domain" - ] + "group": "Monetization", + "pages": ["payments/revenuecat-setup", "payments/stripe-setup"] }, { - "group": "Mobile Apps", - "pages": [ - "getting-started/sharing-app", - "getting-started/home-screen-widgets", - "getting-started/deploy-app-store" - ] + "group": "App Capabilities", + "pages": ["features/haptics", "features/sound-generation", "features/image-generation"] } ] }, @@ -125,53 +61,40 @@ "groups": [ { "group": "Overview", - "pages": [ - "integrations/index" - ] + "pages": ["integrations/index"] }, { "group": "Text Generation", - "pages": [ - "integrations/openai-gpt-5-mini", - "integrations/grok-4-fast", - "integrations/google-gemini" - ] + "pages": ["integrations/openai-gpt-5-mini", "integrations/grok-4-fast", "integrations/google-gemini"] }, { "group": "Audio", - "pages": [ - "integrations/gpt-4o-audio-transcription", - "integrations/elevenlabs-tts", - "integrations/elevenlabs-sound-effects", - "integrations/elevenlabs-music" - ] + "pages": ["integrations/gpt-4o-audio-transcription", "integrations/elevenlabs-tts", "integrations/elevenlabs-sound-effects", "integrations/elevenlabs-music"] }, { "group": "Image Generation", - "pages": [ - "integrations/openai-gpt-image-1", - "integrations/nano-banana", - "integrations/ideogram-3" - ] + "pages": ["integrations/openai-gpt-image-1", "integrations/nano-banana", "integrations/ideogram-3"] }, { "group": "Data APIs", - "pages": [ - "integrations/apple-maps", - "integrations/tmdb", - "integrations/openweather-api", - "integrations/stock-market-data", - "integrations/crypto-market-data", - "integrations/runtime-logs", - "integrations/haptic-feedback" - ] + "pages": ["integrations/apple-maps", "integrations/tmdb", "integrations/openweather-api", "integrations/stock-market-data", "integrations/crypto-market-data", "integrations/runtime-logs", "integrations/haptic-feedback"] }, { "group": "Communication", - "pages": [ - "integrations/resend-email", - "integrations/expo-push-notifications" - ] + "pages": ["integrations/resend-email", "integrations/expo-push-notifications"] + } + ] + }, + { + "tab": "Deploying", + "groups": [ + { + "group": "Web Apps", + "pages": ["deploying/guide", "deploying/custom-domain"] + }, + { + "group": "Mobile Apps", + "pages": ["getting-started/sharing-app", "getting-started/home-screen-widgets", "getting-started/deploy-app-store"] } ] }, @@ -180,14 +103,7 @@ "groups": [ { "group": "Resources", - "pages": [ - "custom-gpt", - "resources", - "updates", - "resources/community", - "resources/glossary", - "support" - ] + "pages": ["resources", "custom-gpt", "faqs", "resources/community", "resources/glossary", "support", "updates"] } ] } diff --git a/faq/app-ideas.mdx b/faq/app-ideas.mdx deleted file mode 100644 index 1dcf3f6..0000000 --- a/faq/app-ideas.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: "App Ideas" -description: "Inspiration and tips for creating your first app" ---- - -# Coming up with App Ideas - -## What kind of app should I build? - -The best app idea is one that solves a problem you or someone you know experiences. Think about daily frustrations, activities you enjoy, or tasks you'd like to automate. Vibecode can help you build it quickly, regardless of complexity. - -## Can I build a real business app? - -Absolutely! Many successful apps started as small projects. With Vibecode's backend capabilities through Vibecode Cloud, you can build production-ready apps with user authentication, databases, and integrations right from the start. - -## How do I find inspiration? - -Look at the app stores, browse social media, read product hunt, or ask friends what they wish existed. Often the best ideas come from personal needs or gaps you notice in existing solutions. \ No newline at end of file diff --git a/faq/building-tips.mdx b/faq/building-tips.mdx deleted file mode 100644 index edca56e..0000000 --- a/faq/building-tips.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Building Tips & Best Practices' -description: 'Learn how to build efficiently and effectively with Vibecode' ---- - -## How do I build efficiently with Vibecode? - -We recommend starting by simplifying your idea into the essential features, then build from there. It also helps to have an initial prompt that details the expected outcome in terms of the look, feel, etc. of your app idea. - -## How should I structure my prompts for the best results? - -Our AI Agent is pretty good at coming up with what is needed for building your app regardless of the prompt, but for specific features it is best to be as specific as possible. You can even suggest examples (e.g., "An app that is designed like Duolingo" or "make the app have the Google color scheme"). The models will continue to get better (and are already crazy good), so prompting will only get easier. - -## What should I do when I hit an error? - -Either copy and paste the error back into the chat, or tell the AI agent that you got an error and it should try to resolve it. - -## How long does it take to complete a project? - -It depends on complexity. By breaking tasks into smaller steps, planning ahead, and refining based on feedback, you can move quickly while ensuring quality. diff --git a/faq/data-integrations.mdx b/faq/data-integrations.mdx deleted file mode 100644 index 6f4bf46..0000000 --- a/faq/data-integrations.mdx +++ /dev/null @@ -1,20 +0,0 @@ ---- -title: 'Data & Integrations' -description: 'Questions about backends, APIs, and data storage' ---- - -## Can I connect my project to a backend to store data? - -This is a feature that is coming very soon. - -## Can I add login to my app? - -We currently do not support Auth/DB, so we do not recommend adding this feature even though it is possible. If it is added, there is a chance you could lock yourself out of your own app without being able to recover it since there is no database functionality (yet). - -## Can I add third-party APIs to my project? - -Yes, you can add authentication by integrating with Vibecode Cloud (currently in beta). Simply prompt the AI to add it and follow the instructions. - -## Can I store sensitive API keys in Vibecode? - -If you're integrating with an API, we recommend you use Vibecode app ENV tab to store your API keys. However, remember if your keys are prefixed with "EXPO_PUBLIC_", they are public. diff --git a/faq/getting-started.mdx b/faq/getting-started.mdx deleted file mode 100644 index 1377f35..0000000 --- a/faq/getting-started.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: 'Getting Started with Vibecode' -description: 'Learn the basics about Vibecode and what you can build' ---- - -## What is Vibecode? - -Vibecode is the easiest way to build beautiful mobile apps. You can simply generate apps with prompting, view and test your app on your phone, improve and complete the development of your app, and share with anyone in 1-click using App Clips. - -Vibecoding allows you to create anything you imagine, and Vibecode is the first ever mobile app that brings the power of Vibecoding to the masses. - -## What can I build with Vibecode? - -Mobile apps for iOS devices. The world is your oyster—you can build whatever comes to your mind. - -## Do I need coding experience to build with Vibecode? - -No. Vibecode is designed for all levels of experience. Whether you're a developer or a non-technical user, you can create apps using Vibecode. - -## Can I start from templates? - -We have this feature coming very soon. Check back in a few weeks! diff --git a/faq/tips-tricks.mdx b/faq/tips-tricks.mdx deleted file mode 100644 index 35340d9..0000000 --- a/faq/tips-tricks.mdx +++ /dev/null @@ -1,18 +0,0 @@ ---- -title: 'Tips & Tricks' -description: 'Pro tips for getting the most out of Vibecode' ---- - -# Tips & Tricks - -## Write detailed prompts - -The more specific your instructions, the better the output. Instead of "make a button," try "create a green button with rounded corners that says 'Get Started' and triggers a success sound." - -## Iterate quickly - -Build your app in small increments. Make one feature, test it, then move to the next. This approach helps you catch issues early and refine your vision as you go. - -## Use Vibecode Cloud for real apps - -If you want to build an app with user data, authentication, or backend logic, use Vibecode Cloud. It handles all the infrastructure so you can focus on your app's core features. diff --git a/faqs.mdx b/faqs.mdx index 040c28c..0a752ff 100644 --- a/faqs.mdx +++ b/faqs.mdx @@ -9,9 +9,7 @@ Find answers to common questions about Vibecode, our features, and how to get th - Vibecode is the easiest way to build beautiful mobile apps. You can simply generate apps with prompting, view and test your app on your phone, improve and complete the development of your app, and share with anyone in 1-click using App Clips. - - Vibecoding allows you to create anything you imagine, and Vibecode is the first ever mobile app that brings the power of Vibecoding to the masses. + Vibecode is the easiest way to build apps using natural language. Available on iOS and on the web at vibecodeapp.com, you can generate fully functional apps with prompting, test them in real-time, and share with anyone instantly. @@ -162,15 +160,17 @@ Find answers to common questions about Vibecode, our features, and how to get th - We currently have a Vibecode Cloud feature in beta that allows you to add a backend to your app. It is not yet fully functional. + Yes! Vibecode Cloud provides a built-in backend for your app with database, authentication, and file storage. Just tell the AI "add a database and authentication to my app" and it sets everything up automatically. + + Vibecode Cloud is available on Plus plans and above. See the [Vibecode Cloud guide](/features/vibecode-cloud) for details. - However, you can integrate with backend services like Supabase or Firebase. Simply prompt the AI to add backend connectivity, and it will guide you through the integration process. This allows you to store user data, implement authentication, and build more complex applications. + You can also integrate with external services like Supabase or Firebase if you prefer. Simply prompt the AI to add the integration. - We currently do not support Auth/DB, so we do not recommend adding this feature even though it is possible. If it is added, there is a chance you could lock yourself out of your own app without being able to recover it since there is no database functionality (yet). + Yes! With Vibecode Cloud (available on Plus plans and above), you can add user authentication to your app. Tell the AI "add login to my app" and it will set up secure email/password authentication. - We currently have a Vibecode Cloud feature in beta that allows you to add a backend to your app. It is not yet fully functional. + For Google Sign-In, see the [Google Sign-In setup guide](/google-login/setup). @@ -212,7 +212,7 @@ Find answers to common questions about Vibecode, our features, and how to get th 1. Go to the Vibecode dashboard/workspace 2. Navigate to Settings or Account 3. Select "Upgrade" or "Plans" - 4. Choose your desired plan (Pro, Premium, etc.) + 4. Choose your desired plan (Plus, Pro, or Max) 5. Complete the payment process Upgrading gives you access to more credits, advanced features, and increased usage limits. diff --git a/features/sound-generation.mdx b/features/sound-generation.mdx index 625fa4e..0b1dada 100644 --- a/features/sound-generation.mdx +++ b/features/sound-generation.mdx @@ -3,8 +3,6 @@ title: "Sound Generation" description: "Create and integrate dynamic audio experiences in your apps" --- -# Sounds and Music - Adding sound to your mobile app transforms how users experience it. A satisfying click confirms a button tap, a chime celebrates success, and ambient music sets the mood for focus or relaxation. With Vibecode, you can generate and integrate audio for any moment—whether it's feedback on user actions, voice guidance, or immersive background music. The right sounds make your app feel polished, responsive, and memorable.