Skip to content

Commit bdc1d91

Browse files
authored
Add contribution guidelines link (#117)
* Add contribution guidelines link * minor updates
1 parent a3cdfa0 commit bdc1d91

File tree

1 file changed

+29
-23
lines changed

1 file changed

+29
-23
lines changed

README.md

Lines changed: 29 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,46 @@
1-
21
# 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.
2+
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, or adding a new topic, your contributions help everyone.
43

54
Below you'll find guidelines on how you can contribute to different parts of the documentation.
65

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.
6+
## A Little Note on Tooling
7+
- Most of our documentation is written in `Markdown`, making it super easy to edit files.
8+
- You can choose to edit Markdown directly in GitHub or open up the entire repository in StackBlitz.
109

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

13-
TO DO: add more details
12+
## Contribution Guidelines
13+
Before you start contributing, please take a moment to review our [Contribution Guidelines](https://flutterflow.notion.site/Docs-Contribution-Guidelines-42829c305df441f6b061b4095abac8a8). This document outlines the process and expectations for contributions to ensure a smooth collaboration.
1414

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.
15+
## How to Contribute
16+
1. **Editing Existing Pages**:
17+
To make edits to an existing page in [docs.flutterflow.io](https://docs.flutterflow.io), you can use the "Edit this page" button that appears at the bottom of each page. This button will bring you straight to the source of the page in GitHub.
1818

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.
19+
2. **Adding a New Docs Page**:
20+
To add a new docs page, simply create a new Markdown page in an existing subdirectory within the `/docs` directory.
2121

22-
To ensure that page shows up on the sidebar, add its path to the docsSidebar object inside the sidebars.ts file.
22+
3. **Create a PR to `main`**:
23+
After making these changes, commit them to a new branch, and then create a pull request (PR) for review from FlutterFlow team.
2324

24-
## 3. Adding a Troubleshooting Guide
25-
To add a new troubleshooting guide, simply create a new mardkown page in the docs/troubleshooting directory.
25+
## Ready to Contribute?
26+
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!
2627

27-
## 4. Adding a Blog
28-
To add a new blog, simply create a new mardkown page in the blogs directory.
28+
[//]: # (Top Contributors)
2929

30-
## 5. Generating the Changelog
31-
TO DO: auto-generating changelog
30+
[//]: # (We value the hard work and dedication of our contributors. Here’s a list of our top contributors, automatically generated:)
3231

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!
32+
[//]: # ()
33+
[//]: # (shell)
34+
35+
[//]: # (Copy code)
36+
37+
[//]: # (# Script to add top contributors)
38+
39+
[//]: # (npx @octokit/rest.js --run "repos.listContributors({)
3540

36-
### Top Contributors
41+
[//]: # (owner: 'flutterflow',)
3742

38-
TO DO: *Perhaps we have some top contributors tabe that's autogenerated*?
43+
[//]: # (repo: 'documentation')
3944

45+
[//]: # (})")
4046
If you have any questions or need further guidance, don't hesitate to reach out to the documentation team. Happy documenting!

0 commit comments

Comments
 (0)