Skip to content

Commit 08728e8

Browse files
authored
Merge pull request #8 from FlutterFlow/leighajarett/more-edits
adding stuff
2 parents 436c902 + a3b7f4f commit 08728e8

30 files changed

+27938
-2224
lines changed

README.md

Lines changed: 25 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,40 @@
1-
# Website
21

3-
This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
2+
# Welcome to the FlutterFlow Documentation Repository!
3+
We're thrilled to have you here! Our documentation is a crucial resource for both new and existing users of FlutterFlow, and it grows and improves with contributions from our community. Whether you're fixing a typo, discussing a new topic, adding a troubleshooting guide, or sharing your experiences in a blog post, your contributions help everyone.
44

5-
### Installation Test
5+
Below you'll find guidelines on how you can contribute to different parts of the documentation.
66

7-
```
8-
$ yarn
9-
```
7+
### A little note on tooling
8+
Most of our documentation is written in markdown, which means it's super easy edit files.
9+
You can choose to edit markdown directly in GitHub, or you can open up the entire reposiitory in StackBlitz.
1010

11-
### Local Development
11+
Either way, you'll need to open up a pull request, and get an approval from at least one-code owner.
1212

13-
```
14-
$ yarn start
15-
```
13+
TO DO: add more details
1614

17-
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
15+
## 1. Editing Existing Pages
16+
To make edits to an existing page, you can use the "Edit this page" button that appears at the bottom of each page.
17+
That brings you straight to the source of the page in GitHub.
1818

19-
### Build
19+
## 2. Adding a New Docs Page
20+
To add a new docs page, simply create a new markdown page in a subdirectory within the docs directory.
2021

21-
```
22-
$ yarn build
23-
```
22+
To ensure that page shows up on the sidebar, add its path to the docsSidebar object inside the sidebars.ts file.
2423

25-
This command generates static content into the `build` directory and can be served using any static contents hosting service.
24+
## 3. Adding a Troubleshooting Guide
25+
To add a new troubleshooting guide, simply create a new mardkown page in the docs/troubleshooting directory.
2626

27-
### Deployment
27+
## 4. Adding a Blog
28+
To add a new blog, simply create a new mardkown page in the blogs directory.
2829

29-
Using SSH:
30+
## 5. Generating the Changelog
31+
TO DO: auto-generating changelog
3032

31-
```
32-
$ USE_SSH=true yarn deploy
33-
```
33+
### Ready to Contribute?
34+
Your contributions are vital to keeping FlutterFlow's documentation clear, up-to-date, and helpful. We look forward to seeing your pull requests and are excited to welcome you into our community of contributors!
3435

35-
Not using SSH:
36+
### Top Contributors
3637

37-
```
38-
$ GIT_USER=<Your GitHub username> yarn deploy
39-
```
38+
TO DO: *Perhaps we have some top contributors tabe that's autogenerated*?
4039

41-
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
40+
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!

blog/2019-05-28-first-blog-post.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

blog/2019-05-29-long-blog-post.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

blog/2021-08-01-mdx-blog-post.mdx

Lines changed: 0 additions & 20 deletions
This file was deleted.
Binary file not shown.

blog/2021-08-26-welcome/index.md

Lines changed: 0 additions & 25 deletions
This file was deleted.

blog/authors.yml

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,6 @@
1-
endi:
2-
name: Endilie Yacop Sucipto
3-
title: Maintainer of Docusaurus
4-
url: https://github.com/endiliey
5-
image_url: https://github.com/endiliey.png
6-
7-
yangshun:
8-
name: Yangshun Tay
9-
title: Front End Engineer @ Facebook
10-
url: https://github.com/yangshun
11-
image_url: https://github.com/yangshun.png
12-
13-
slorber:
14-
name: Sébastien Lorber
15-
title: Docusaurus maintainer
16-
url: https://sebastienlorber.com
1+
# Support team authors
2+
barry:
3+
name: Barry
4+
title: FlutterFlow Support Team
5+
# url: https://sebastienlorber.com
176
image_url: https://github.com/slorber.png

blog/overview.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: FF Blog Overview
3+
sidebar_position: 1
4+
---

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import BranchIcon from '@site/static/icons/branch_New.png';
2525
### FlutterFlow is a visual development environment that lets you build mobile, web, and desktop apps incredibly fast, without sacrificing quality or features.
2626

2727
<InfoCards>
28-
<InfoCard icon={GearIcon} title="Before You Begin" description="Ensure you meet system requirements and grasp technical concepts for smooth building in FlutterFlow." />
28+
<InfoCard icon={GearIcon} title="Before You Begin" description="Ensure you meet system requirements and grasp technical concepts for smooth building in FlutterFlow." pagePath="/intro/before-you-begin/setting-up-flutterflow" />
2929
<InfoCard icon={DocsIcon} title="Explore FlutterFlow" description="Dive into the building blocks of the platform: projects, widgets, functions and more." />
3030
<InfoCard icon={DeviceIcon} title="Start Building" description="Jump right into a quick start on how to build a simple app." />
3131
<InfoCard icon={CheckIcon} title="Troubleshooting Guides" description=" Solutions and tips to solve common FlutterFlow development hurdles." />

docs/intro/app-architecture.md renamed to docs/intro/before-you-begin/app-architecture.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
sidebar_position: 1
2+
title: App Architecture
33
---
44

55
# App Development

0 commit comments

Comments
 (0)