Home
Any member of the community is welcome to suggest changes to Frontity's official documentation at any time. Frontity's documentation can be found at https://docs.frontity.org/. Any and all help is very much appreciated!
Your changes will not be visible right away, the Developer Relations Team will first review them and then merge them if the suggested changes are approved. So you don't need to worry about breaking anything!
If you're stuck at any point, don't hesitate to use our Community Forum to ask for help or to make your suggestions.
We use gitbook to generate the documentation site which is connected to our gitbook-docs repository (every time the master branch is updated the whole documentation site is rebuilt).
The documents in the gitbook-docs repository use Markdown syntax to add format and structure to the texts.
If you want to know more about Markdown then take a look at:
This gitbook-docs repository is the source of truth for Frontity's documentation, so any suggested changes are managed through Pull Requests (to its master branch).
There are 2 different workflows you can use to suggest changes:
For minor changes, or if you're new to GitHub, we suggest that you use the
Edit on Githubworkflow, because it's a quick and easy way to make changes. If you have knowledge of Git and/or your proposed changes are more extensive then we recommend that you useLocal Edit & Push.
1. Edit on Github workflow
You can edit documentation directly online in your browser.
This workflow can be used for minor changes.
For extensive changes, we recommended that you use Local Edit & Push.
Learn more about this workflow here.
2. Local Edit & Push workflow
If you are familiar with Git, you can use the Local Edit & Push workflow. This, in fact, is the preferred method for all but very minor changes.
If you've previously contributed to other projects on GitHub via pull requests, you should already be familiar with this workflow.
Learn more about this workflow here.