Contribute

Contribute

If you would like to contribute towards improving the docs you can do so directly through Github.

On each page there is a link to the relevant mdx file on Github which you can edit directly and push up a pull request to get the updates added to the site.

How to contribute

Go directly to https://github.com/flayerlabs/flaunch-docs (opens in a new tab) and click on the pages folder to find the relevant page you would like to edit, or alternatively navigate to the page within these docs and click on the

Edit this page

Click on the edit icon in the top right of the page to edit the file directly in Github.

Edit this page

Make the changes in Github and the click on the Commit changes button at the top right of the page.

Make changes in Github

This will create a new branch and a pull request which will be reviewed by the Flayer team before being merged into the site. Add any comments that you think are relevant to the pull request and then click on the Propose changes button.

Commit changes in Github

Go back and repeat this process for any other pages you would like to edit.

Once you are happy you can Create the Pull Request and the Flayer team will review and merge the changes.

Create PR

Markdown

The site is written in Markdown and uses the mdx format which allows for the inclusion of React components and other features. You can find out more about the mdx format at https://mdxjs.com/ (opens in a new tab)

https://mdxjs.com/table-of-components/ (opens in a new tab)