Skip to content

Commit 1084519

Browse files
Revamp docs design! (#452)
* update card ui for info cards / feature cards * draft changes on sidebar + home page * add more content to home page + UI fixes * remove unnecessary * reduce img size * add advanced doc links * move automated tests to testing app folder * update content for home page * update tos links * move refunds to subscriptions * Apply suggestions from code review Co-authored-by: pinkeshmars <71133091+pinkeshmars@users.noreply.github.com> * update color for selected sidebar item * update card border color --------- Co-authored-by: pinkeshmars <71133091+pinkeshmars@users.noreply.github.com>
1 parent 57085e9 commit 1084519

File tree

21 files changed

+510
-75
lines changed

21 files changed

+510
-75
lines changed

docs/accounts-billing/privacy-terms-of-service.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ To request deletion of your personal data, please reach out to our support team
1212
To unsubscribe from FlutterFlow emails, please click the “Unsubscribe” link in the footer of our emails.
1313

1414
### Where can I view your Privacy Policy?
15-
You can review the most recent version of our Privacy Policy here.
15+
You can review the most recent version of our Privacy Policy [on the website](https://www.flutterflow.io/privacy).
1616

1717
### Where can I view your Terms of Service (ToS)?
18-
You can review the most recent version of our Terms of Service here.
18+
You can review the most recent version of our Terms of Service [linked on the website](https://www.flutterflow.io/tos).

docs/accounts-billing/subscriptions/more-subscription-faqs.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
1+
---
2+
toc_max_heading_level: 5
3+
sidebar_position: 2
4+
---
25

36
# Other Subscription Questions
47

docs/accounts-billing/refund.md renamed to docs/accounts-billing/subscriptions/refund.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ sidebar_position: 4
88

99

1010
# Refunds
11-
If you're not happy with your FlutterFlow subscription, you can [cancel at any time](subscriptions/subscriptions.md#cancel-my-plan).
11+
If you're not happy with your FlutterFlow subscription, you can [cancel at any time](./subscriptions.md#cancel-my-plan).
1212

1313
However, there are no refunds for cancellation. In the event that the Company suspends or terminates your Account or these Terms, you understand and agree that you shall receive no refund, whether for any unused time on a subscription, any license or subscription fees for any portion of the Service, any content or data associated with your User Account, or for anything else.

docs/accounts-billing/subscriptions/subscriptions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ slug: subscriptions
33
title: Subscriptions
44
tags: []
55
toc_max_heading_level: 5
6-
sidebar_position: 3
6+
sidebar_position: 0
77
---
88

99

docs/index.md

Lines changed: 127 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ custom_edit_url: null
44
showLastUpdateTime: false
55
hide_title: true
66
slug: /
7-
hide_table_of_contents: true
7+
hide_table_of_contents: false
88
---
99

1010
import InfoCard from '@site/src/components/InfoCard';
@@ -20,25 +20,140 @@ import BranchIcon from '@site/static/icons/branch_New.png';
2020

2121

2222

23-
<FlutterFlowLogo></FlutterFlowLogo>
2423

25-
# Visual Development Environment
26-
FlutterFlow is a visual development environment that lets you build mobile, web, and desktop apps incredibly fast, without sacrificing quality or features.
24+
# Getting Started with FlutterFlow
25+
FlutterFlow is a visual development environment that lets you build mobile, web, and desktop apps incredibly fast, without sacrificing on app quality or features.
26+
2727

28-
<div class="video-container small"><iframe src="https://www.youtube.com/embed/gYOrgBrX4jM" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div>
2928

3029
<InfoCards>
31-
<InfoCard title="Before You Begin" description="Ensure you meet system requirements and grasp technical concepts for smooth building in FlutterFlow." pagePath="/before-you-begin/setup-flutterflow" />
32-
<InfoCard title="Explore FlutterFlow" description="Dive into the building blocks of the platform: projects, widgets, functions and more." pagePath="/resources"/>
33-
<InfoCard title="Start Building" description="Jump right into a quick start on how to build a simple app." pagePath="/quickstart"/>
34-
<InfoCard title="What's New in FlutterFlow" description="Updates, features, and the latest enhancements in FlutterFlow." pagePath="https://community.flutterflow.io/c/whats-new-in-flutterflow"/>
35-
<InfoCard title="Community Forum" description="Join discussions, ask questions, and share insights with the FlutterFlow community." pagePath="https://community.flutterflow.io"/>
36-
<InfoCard title="Submit Bug Report" description="Encountered a bug in FlutterFlow? Help us improve by submitting a bug report." pagePath="/misc/submit-bug-report" />
30+
<InfoCard
31+
icon="🚀"
32+
title="Build Your First App"
33+
description="Get started with FlutterFlow by building your first FlutterFlow app step-by-step."
34+
pagePath="/quickstart"
35+
isLarge={true}
36+
/>
37+
<InfoCard
38+
icon="🗺️"
39+
title="App Development Roadmap"
40+
description="Learn the three essential layers of app development: UI Layer, Logic Layer, and Data Layer for building FlutterFlow applications."
41+
pagePath="/roadmap"
42+
isLarge={true}
43+
/>
3744

3845
</InfoCards>
3946

47+
<p></p>
48+
49+
4050
<p></p>
4151

4252
### FlutterFlow Tour
4353

44-
<div class="video-container"><iframe src="https://www.youtube.com/embed/GpXjU-ieAKU?si=moIEUUGry24CdSJN" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div>
54+
<InfoCards>
55+
56+
<InfoCard
57+
icon="🏗️"
58+
title="FlutterFlow Builder"
59+
description="Explore the FlutterFlow Builder interface, learn about the dashboard, widgets panel, and how to navigate the visual development environment."
60+
pagePath="/flutterflow-ui/dashboard"
61+
isLarge={true}
62+
/>
63+
64+
<InfoCard
65+
icon="🔍"
66+
title="Building Blocks"
67+
description="Dive into the building blocks of the platform: projects, widgets, functions and more."
68+
pagePath="/resources"
69+
isLarge = {true}
70+
/>
71+
72+
73+
</InfoCards>
74+
75+
<p></p>
76+
77+
<div class="video-container"><iframe src="https://www.youtube.com/embed/GpXjU-ieAKU?si=moIEUUGry24CdSJN" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe></div>
78+
79+
80+
81+
82+
83+
84+
### Best Practices
85+
86+
Essential guidelines and recommendations for building robust FlutterFlow applications. Discover security best practices and performance optimization techniques to ensure your apps are production-ready, scalable, and maintainable.
87+
88+
<InfoCards>
89+
<InfoCard
90+
icon="🔐"
91+
title="Secure your API Key"
92+
description="Learn best practices for keeping your API keys created in Google Cloud Console safe and secure in production applications."
93+
pagePath="/best-practices/secure-api-keys"
94+
isLarge={true}
95+
/>
96+
<InfoCard
97+
icon="🧪"
98+
title="Test Your Apps Locally"
99+
description="Set up Local Run to debug and validate your app in physical devices."
100+
pagePath="/testing/local-run"
101+
/>
102+
<InfoCard
103+
icon="📝"
104+
title="Naming Variables"
105+
description="Learn FlutterFlow naming conventions and best practices for variables, functions, and components to maintain clean, readable code."
106+
pagePath="/resources/style-guide"
107+
/>
108+
</InfoCards>
109+
110+
### Scaling FlutterFlow Apps
111+
112+
Learn advanced techniques and strategies to scale your FlutterFlow applications from simple prototypes to enterprise-grade solutions with native integrations and modular architecture.
113+
114+
<InfoCards>
115+
<InfoCard
116+
icon="🔌"
117+
title="Integrating Native Plugins in FlutterFlow"
118+
description="Extend FlutterFlow's capabilities by integrating native platform plugins and custom functionality using method channels for advanced app development."
119+
pagePath="/concepts/advanced/method-channels"
120+
isLarge={true}
121+
/>
122+
<InfoCard
123+
icon="🏗️"
124+
title="Building Super Apps using Libraries"
125+
description="Discover how to create scalable, modular applications using FlutterFlow libraries to build complex, maintainable super apps with independent feature libraries."
126+
pagePath="https://blog.flutterflow.io/scaling-super-apps-modular-architecture-with-flutterflow-libraries/"
127+
/>
128+
129+
</InfoCards>
130+
131+
### Additional Tools
132+
133+
Discover additional tools and references to enhance your FlutterFlow development experience:
134+
<InfoCards>
135+
<InfoCard
136+
icon="⚙️"
137+
title="System Requirements"
138+
description="Ensure you meet system requirements required to smoothly run FlutterFlow application on the web & desktop."
139+
pagePath="/before-you-begin/setup-flutterflow"
140+
/>
141+
<InfoCard
142+
icon="🆕"
143+
title="What's New in FlutterFlow"
144+
description="Follow latest updates, features, and the latest enhancements in FlutterFlow."
145+
pagePath="https://community.flutterflow.io/c/whats-new-in-flutterflow"
146+
/>
147+
148+
</InfoCards>
149+
150+
## Still Have Problems?
151+
152+
If you're still experiencing issues or need additional help, here are some resources to get you back on track:
153+
154+
- **[Submit Bug Report](/misc/submit-bug-report)** - Report bugs or issues you've encountered
155+
- **[Community Forum](https://community.flutterflow.io)** - Ask questions and get help from the community
156+
- **[Reddit Community](https://www.reddit.com/r/FlutterFlow/)** - Join discussions on Reddit
157+
- **[Documentation Bug](https://github.com/FlutterFlow/flutterflow-documentation/issues)** - Report documentation issues
158+
- **[Contribute to Documentation](https://github.com/FlutterFlow/flutterflow-documentation?tab=readme-ov-file#how-to-contribute)** - Contribution guidelines for contributing to the FlutterFlow documentation site.
159+
- **[FlutterFlow Support](mailto:support@flutterflow.io)** - Get direct support from the FlutterFlow support team.

docs/marketplace/creators-hub/creators-hub.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,11 +10,11 @@ keywords: [FlutterFlow, MarketPlace, Creators Hub]
1010
# Creators Hub
1111
Welcome to the FlutterFlow Marketplace Creators' Hub! This section is designed to provide you with all the necessary information to contribute effectively and responsibly to Marketplace. Whether you are submitting your first item or looking to understand the legal nuances, you'll find detailed guidelines and helpful tips here.
1212

13-
### **Submitting an Item for Review**
13+
### Submitting an Item for Review
1414
- Understand the [criteria](submission-criteria.md) we apply to items submitted to Marketplace.
1515
- Learn how to prepare and [submit](submit-item-for-review.md) your items to the Marketplace with our step-by-step guide.
1616

17-
### **Legal Guidelines for Creators**
17+
### Legal Guidelines for Creators
1818

1919
A user-friendly [guide](legal-guidelines-for-creators.md) outlining what content can and cannot be published on our Marketplace.
2020

docs/marketplace/creators-hub/submission-criteria.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ Stay tuned for an upcoming "style guide" we're publishing that goes into deeper
396396
- **Criteria:** Projects should include automated tests that verify core functionality and key user workflows. While not required for approval, this is strongly recommended for libraries and will positively impact visibility.
397397
- **Why It Matters:** Automated tests help ensure reliability, catch regressions, and demonstrate your commitment to quality. They also improve your item's visibility.
398398
- **What To Do:**
399-
- **Add Integration Tests:** Use FlutterFlow's [automated testing](../../testing-deployment-publishing/testing/automated-tests.md) features to verify your item's core functionality.
399+
- **Add Integration Tests:** Use FlutterFlow's [automated testing](../../testing-deployment-publishing/running-your-app/automated-tests.md) features to verify your item's core functionality.
400400
- **Test Key Workflows:** Focus on testing critical user paths and features that users will rely on.
401401
- **For Libraries:** Since libraries are often used as building blocks in larger applications, thorough testing is particularly important to:
402402
- Verify that Library Values are properly implemented

docs/resources/ui/widgets/widget-commonalities.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Values beyond this range will push the widget outside the visible screen area.
172172

173173
## Add Testing Value Key
174174

175-
A **Value Key** is used to uniquely identify widgets during [**Automated Testing**](../../../testing-deployment-publishing/testing/automated-tests.md) in FlutterFlow. For example, on a Create Account page, you might use descriptive keys like `signupFirstNameField`, `signupEmailField`, `signupPasswordField`, and `signupSubmitButton`. This helps testing tools reliably locate and interact with the correct widgets. For more details, refer to the [complete guide here](../../../testing-deployment-publishing/testing/automated-tests.md).
175+
A **Value Key** is used to uniquely identify widgets during [**Automated Testing**](../../../testing-deployment-publishing/running-your-app/automated-tests.md) in FlutterFlow. For example, on a Create Account page, you might use descriptive keys like `signupFirstNameField`, `signupEmailField`, `signupPasswordField`, and `signupSubmitButton`. This helps testing tools reliably locate and interact with the correct widgets. For more details, refer to the [complete guide here](../../../testing-deployment-publishing/running-your-app/automated-tests.md).
176176

177177
![test-value-keys.avif](imgs/test-value-keys.avif)
178178

docs/testing-deployment-publishing/publishing/pre-checks-publishing.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ This page outlines the important steps and checks to be made before publishing y
1313

1414
Here’s a comprehensive list of these prechecks:
1515

16-
1. **Functionality Testing**: Test the app manually across devices. You can also implement integration tests using FlutterFlow’s [**Automated Tests**](../testing/automated-tests.md) framework to cover various scenarios.
16+
1. **Functionality Testing**: Test the app manually across devices. You can also implement integration tests using FlutterFlow’s [**Automated Tests**](../running-your-app/automated-tests.md) framework to cover various scenarios.
1717

1818
2. **Get Feedback**: Run your app in Run Mode to generate a shareable link to the session. You can share these links to gather feedback from users and testers, providing valuable insights and potential areas of improvement before the public release.
1919
3. **Optimizations & Enhancements**: Improve performance by implementing [optimization and enhancement](../../intro/ff-ui/toolbar.md#project-suggestions) suggestions. Ensure that images are properly sized, consider using higher compression for assets, and remove unused assets and custom widgets. These will help improve your app's speed and size.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"label": "Running your App",
2+
"label": "Testing your app",
33
"position": 3
44
}

0 commit comments

Comments
 (0)